Picture

Introduction

Welcome to the Zelis Developer Portal! Integrating our suite of APIs into your platform is the first step toward creating a frictionless experience for your users. This quick start guide will provide everything you need to know to start accessing, testing, and managing Zelis APIs.   

When you access the Zelis Developer Portal, you’ll see a few key pages on the menu: 

  • API Catalog: Use this space to explore the available Zelis APIs. You will need to log in to or sign up for the Developer Portal to view API details and documentation. However, you can read a short description of each API’s functionality from this page.  

  • Guides: Get helpful instructions and tips for using the Developer Portal and Zelis APIs.  

  • Support: Have questions about API products, registration, subscriptions, or other issues? Visit our FAQ page for answers to common questions or contact our team for support.

  • Sign Up: Fill out our signup form to request access to the Developer Portal.  

  • Log In: Log in to your account to review API details and documentation. You'll also be able to manage your API subscriptions, view and regenerate keys, and monitor your subscription status.  

Registration & Login

To view API details and documentation, test the functionality of APIs, and make purchases, you will need to create an account on the Zelis Developer Portal. Once you fill out the signup form, a member of our team will review and approve your signup request. Take these steps to sign up and set up your account. 

1. Access the signup page via the Developer Portal menu. 

2. Fill out the signup form with your information. There are optional and required fields, and the required fields are marked with an asterisk (*). You will need a business email address to sign up. 

3. Click the “Sign up” button to submit the form. 

4. You will receive an email to your business email address confirming that your signup request has been received. The email will prompt you to confirm your email address.  

5. Click the button in the email to confirm your email address.  

6. The Zelis team will review your registration request.

7. Once your registration request has been approved, you’ll receive an email with a temporary password.  

8. Log in to the Developer Portal using your temporary password.

9. Once you log in for the first time, you’ll be prompted to create a new password. Create and confirm a new password using the password logic.  

  • Your password must contain the following: 

    • At least 10 characters 

    • Maximum password character length - 25 

    • At least one number (0-9) 

    • At least one lowercase (a-z) 

    • At least one upper case (A-Z) 

    • At least one symbol @ # $ % ^ & * - _ + = [ ] { } | \ : ' , ? / ` ~ " ( ) ; 

10. You’re now logged in as a registered user and can explore the Zelis APIs in more detail. 

Registration Confirmation

If you do not receive your initial confirmation email after signing up, you may troubleshoot the following: 

  • Check your spam folder and add no-reply-portal@zelismail.com to your email account whitelist/allow list.  

  • If your confirmation email is not located in your SPAM folder, please contact apisupport@zelis.com to request another account confirmation email. 

  • Please note that the verification email link expires in 48 hours. If the link has expired, click the Resend verification link button to request a new email.

Temporary Password

Upon account approval, you will be emailed a temporary password. Use this temporary password for your initial login. Note that your temporary password will expire in 48 hours. Upon your first successful login, you will be prompted to change your password.

Please contact support if your temporary password expires.

Security and Authentication 

Zelis APIs utilize the following formatting and security protocols: 

  • HTTPS: Zelis APIs are accessible through HTTPS.

  • JSON: Request and response contents are in JSON format. 

  • OAuth: Zelis requires an OAuth2 bearer authorization token for all Zelis API requests.  

API Quick Start Guide 

Explore API Products 

You can explore Zelis API products from the ‘API Catalog' page. Each product card displays a brief API description and an option to View API Details. If you can’t see the ‘View API Details’ link on the product card, log in or register for an account.  

API URLs and Endpoints 

Production Base URL: https://api.zelis.com/

Using our REST APIs 

Zelis APIs utilize secure OAuth authentication and a subscription key to create a secure connection. Users must obtain OAuth credentials and generate AuthToken to make requests in the API gateway. 

Example of OAuth2 Token Request:
Method: POST 
Endpoint: https://api.zelis.com/auth/token 
Body: Body type form URL encoded

  • clientId = {{clientId}} 

  • clientSecret = {{clientSecret}} 

  • tenantId = {{tenantId}} (optional, an invalid value leads to 401 unauthorized error) 

To generate an AuthToken, navigate to Profile > My Account > Access Keys, click ‘Get Token and Tenant ID,’ then select the ‘Get Token’ endpoint on the AuthToken page and click ‘Try It.’ 

Example of API Request:
Method: <Refer API documentation on Developer portal> 
Endpoint: <Refer API documentation on Developer portal>
Headers: 

  • Ocp-Apim-Subscription-Key = {{SubscriptionKey}} 

  • Authorization = Bearer <token generated in above request> 

Body: <Refer API documentation on Developer portal> 

API credentials 

Zelis provides the credentials after signing a contract or obtaining a subscription. For security reasons, these credentials are unique to an API environment and client. Details of each credential is as follows: 

clientId: Serves as a unique identifier for the API client.   

clientSecret: Authenticates the API client. Valid for 1 year (365 days) from the date of generation. 

tenantId(optional): An exclusive identifier for each org within Zelis. This unique identity allows organizations to control resources, access services, and collaborate easily with other tenants. 

  • To obtain a TenantId, go to the Access Keys page, click ‘Get Token and Tenant ID,’ select ‘Get Tenants,’ click ‘Try It,’ enter AuthToken value in headers, click ‘Send,’ and copy the Tenant ID from the response. 

  • Tenant IDs are retrieved only for users with applicable access. If your account is not configured for this functionality, the response will be blank.    

subscription key: Each request to the API requires the Ocp-Apim-Subscription-Key header with your subscription key value.  

Path: Navigate to Profile > My Account > Access Keys to find the clientId, clientSecret, and subscription key. 

Keep API credentials secure 

Guard your API access credentials and do not share them with others. 

AuthToken

AuthToken is a short-lived access token used to authenticate API requests.  

  • In the production environment and sandbox (if available), Authoken have a lifespan of one hour (or 3,600 seconds).   

  • Zelis recommends automating transactions using the same token throughout its lifespan. Requesting a new token for each transaction is less efficient and does not improve security.

Product & Technical Support

Zelis is committed to providing support throughout the API's lifecycle. Our specialists are available to assist with all inquiries regarding sales, product, and technical support.

Sales Support

If you have any inquiries regarding the subscription to our API products or would like to request quotes, our Zelis sales team is here to provide you with comprehensive assistance and guidance.

Product Support

Whether you're seeking clarification on API functionalities, facing integration challenges, or need guidance on optimizing performance, our Zelis product support team will provide detailed explanations and ensure a smooth and successful implementation of our API products into your platforms.

Technical Support

For comprehensive technical assistance, including help with login, sandbox, and production environment issues, as well as bug reporting and resolution, please contact the Zelis technical support team.

Contact Us

For prompt assistance with any of the support inquiries listed above or for additional inquiries, please contact Zelis API Support team at apisupport@zelis.com.

When reaching out, please provide detailed information about your queries, including a description of the issue, the specific API product you're inquiring about, and your contact information. Our support team will respond promptly to your inquiry.