{"info":{"_postman_id":"c2d789a4-be12-4564-a7b2-e2a02c39b559","name":"Transaksi.Email","description":"

StartFragment

Welcome to KREDIT's Web API. The API lets you manage messages on the KREDIT platform.

Before you start work on our API, you must have access to the KRREDIT platform and the API key.

EndFragment

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23706886","collectionId":"c2d789a4-be12-4564-a7b2-e2a02c39b559","publishedId":"2s83zduQqR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-10-05T03:42:43.000Z"},"item":[{"name":"Getting Started","item":[{"name":"Authentication","item":[],"id":"1db115f6-3837-48d7-8ba5-962704fa1c7f","description":"

KIRIM.EMAIL Transactional APIs are secured using API keys. You can the API key from the smtp domain page. Once you have the API key, you must use it as a password parameter on basic auth method. For username you can use one of the login on smtp credentials page.

\n","_postman_id":"1db115f6-3837-48d7-8ba5-962704fa1c7f"},{"name":"Resource Methods","item":[],"id":"72ffe43e-bd09-459a-bbd2-ec3172b5b3c5","description":"

KIRIM's REST APIs support the following methods:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operation	Description
`GET`	Retrieve resource information
`POST`	Creates a new resource
`PUT`	Inserts or replaces a resource
`DELETE`	Deletes a resource

","_postman_id":"72ffe43e-bd09-459a-bbd2-ec3172b5b3c5"},{"name":"Status Codes","item":[],"id":"6865a7f7-78ab-47fd-9c0a-1bf1714a716b","description":"

When you call any of the KIRIM's REST resources, the Response header returns one of the standard HTTP status codes defined in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP Status Code	Description
`200 OK`	The request was successfully completed. A `200` status is returned for a successful `GET` or `POST` method.
`201 Created`	The request has been fulfilled and resulted in a new resource being created. The response includes a Location header containing the canonical URI for the newly created resource. A `201` status is returned from a synchronous resource creation or an asynchronous resource creation that completed before the response was returned.
`400 Bad Request`	The request could not be processed because it contains missing or invalid information (such as a validation error on an input field or a missing required value).
`401 Unauthorized`	The request is not authorized. The authentication credentials included with this request are missing or invalid.
`403 Forbidden`	The user cannot be authenticated. The user does not have authorization to perform this request.
`404 Not Found`	The request includes a resource URI that does not exist.
`409 Conflict`	The request could not be completed due to a conflict with the current state of the resource. Either the version number does not match, or a duplicate resource was requested.
`500 Internal Server Error`	The server encountered an unexpected condition that prevented it from fulfilling the request.
`503 Service Unavailable`	The server is unable to handle the request due to temporary overloading or maintenance of the server. The REST web application is not currently running.

","_postman_id":"6865a7f7-78ab-47fd-9c0a-1bf1714a716b"},{"name":"Supported Query Parameters","item":[],"id":"a5e9ef2a-14d7-4d1b-9b93-ec95599a66aa","description":"

KIRIM APIs let you sort and filder collections using query parameters. Querying a REST resource is easy: you simply need to know how to talk to your web server to get back the response you want.

You can use the following query parameters to customize the response.

q Query Parameter: You can use the q parameter to query and filter a collection resource.
finder parameter: You can use the finder parameter supported by a resource to query records.
sort parameter: You can use the sort parameter to specify a different property to sort by.
Pagination parameters:
- limit . Sets the page size.
- offset. Determines the record number from which to start retrieval.
- totalResults. Displays the total number of results.
\n

\n","_postman_id":"a5e9ef2a-14d7-4d1b-9b93-ec95599a66aa"}],"id":"5a5db3d2-6a18-4063-a99f-33cebc523aa4","description":"

You can review the content in the Getting Started section to understand how you can easily use KIRIM's REST APIs:

\n","_postman_id":"5a5db3d2-6a18-4063-a99f-33cebc523aa4"},{"name":"Messages","item":[{"name":"Send Message","id":"2976d779-f79a-47a2-bc5f-56720545e4b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"domain","value":"","description":"

Registered domain

\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"from","value":"","description":"

Registered sender from SMTP credentials

\n","type":"text"},{"key":"to","value":"","description":"

Recipient

\n","type":"text"},{"key":"subject","value":"","description":"

Subject

\n","type":"text"},{"key":"text","value":"","description":"

Text

\n","type":"text"},{"key":"html","value":"","description":"

HTML

\n","type":"text"},{"key":"tags","value":"","description":"

Tags (Optional)

\n","type":"text"},{"key":"headers[Reply-To]","value":"","description":"

additionals headers(optional), in array format

\n","type":"text"},{"key":"from_name","value":"","description":"

optional

\n","type":"default"}]},"url":"https://aplikasi.kirim.email/api/v3/transactional/messages","description":"

This method lets you send a message. You must enter the username and password for authorization to send the message.

\n","urlObject":{"protocol":"https","path":["api","v3","transactional","messages"],"host":["aplikasi","kirim","email"],"query":[],"variable":[]}},"response":[],"_postman_id":"2976d779-f79a-47a2-bc5f-56720545e4b4"}],"id":"8ae90d7b-7eaf-4bbd-a34e-73d2ed2d18ac","description":"

The Messages methods let you manage messages that you want to send to subscribers.

\n","_postman_id":"8ae90d7b-7eaf-4bbd-a34e-73d2ed2d18ac"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"05590a43-24c9-4dff-903d-22ec2373929b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ba740ca1-958d-4d8d-9cab-d1e40903a8b3"}}]}