{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"752d160a-f074-4565-89ff-b826639bd542","name":"SendJim Public API v4 - Integration Partners","description":"We now have 2 methods of integration with SendJim - Integration Partner OR Private Label.\n\n**Integration Partner**: This integration approach is ideal if your customers already have their own SendJim accounts and wish to establish workflows between your software and SendJim.\n\n**Private Label:** This integration method is preferable if you aim to set up your own workflows utilizing SendJim's functionality, but your customers do not have SendJim accounts. It is designed for situations where you want the functionality to appear as if it is originating from your software. All transactions will be conducted through a single SendJim account, which you will manage and for which you will purchase credits.\n\nOur API was updated on 12/06/2023. The documentation below is for our new API (version 4). To view version 3 of our api, please click this [link](https://documenter.getpostman.com/view/1717999/sendjim-public-api-v3/6Z2Qshq#api-authentication-high-level-overview).\n\n
\n\nIf you would like to authenticate _other_ send jim customers, and use our API with their accounts, then you are an integration partner and must use OAuth 2.0 authentication.\n\nThe OAuth 2.0 process is as follows:\n\n- First, make sure you have white listed call back urls in the \"Integration Settings\" within the Company Profile page\n- Then, redirect the user to the following URL, passing along your client key and one of your white listed call back URLs as query parameters\n - [https://members.sendjim.com/OAuth/Account?clientKey=CLIENT_KEY&callbackUrl=[WHITE_LISTED_CALLBACK_URL]](https://members.sendjim.com/OAuth/Account?clientKey=CLIENT_KEY&callbackUrl=%5C%5BWHITE_LISTED_CALLBACK_URL%5C%5D)\n - Optionally, you can send a \"**state**\" parameter to the authentication URL above. The \"**state**\" parameter can contain any string data that is relevant to your application. After a successful authentication, we will send the \"**state**\" value to your white-listed redirect URL.\n- The user will be presented with a login form to connect with your company. If the user is already logged in, they will skip the login form and be asked if they would like to share their information with your company.\n \n\n\n\n\n\n- Once the user allows access to your application, the user will be redirected to the call back URL you passed as a query parameter. **Reminder: This URL must be white listed in your company profile's integration settings page.**\n - [http://yourapp.com/callback_url?requestToken=1aa8d6ad-f2c5-4979-91bc-fd656123c945&expires=3599](http://yourapp.com/callback_url?requestToken=1aa8d6ad-f2c5-4979-91bc-fd656123c945&expires=3599)\n- As seen above, SendJim.io will send a request token and an expiration timer to your callback URL. (Note: The expiration integer represents the number of seconds from now that the request token will expire)\n- If a \"**state**\" parameter was provided during the authentication process, we will append the **state** parameter and value to your redirect URL above.\n- Next, using your client key, secret key, and your newly acquired request token, create a POST request to:\n - [https://members.sendjim.com/OAuth/Grant](https://members.sendjim.com/OAuth/Grant)\n - JSON Body\n\n\n\n- Finally, you will receive a JSON response back with the following properties:\n - GrantToken - String\n - UserFirstName - String\n - UserLastName - String\n - Username - String\n- You can now store the Grant Token and send it with every future request for this user. The token must be present in the Authorization header in every API call. Like so:\n - **Authorization Token GRANT_TOKEN_GOES_HERE**\n - **Note** - The Grant Token does not expire\n\n
Additional Details
\n\n1. Optional parameter that you may pass to the \\~/OAuth/Account URL. The State parameter can be any string that you would like to receive back after the OAuth process is complete. More information about this is in our documentation below.\n2. **API Version Header**\n - With API version 3 (and going forward) we **require** a new header to be sent with every API request. That header is called **api_version**. And you must provide the API version you wish to use. Example:\n\n```\n Authorization : Token \\[tokenValue\\] \n api_version: 4 \n\n ```\n\n---\n\n
Conclusion
\n\n
For the authorization headers in the APIs documented below, we will be using the Integration Partner authentication process (OAuth 2.0 Token).
\n\n
If you have any questions, please dont hesitate to contact us at {{help email}}.