Skip to main content

TL;DR;

Basic Integration Concepts

The intention of this document is to provide a basic understanding of the concepts and terminology used in the Client API. It is not intended to be a comprehensive guide to the API, but rather a starting point for developers who are new to the API.

Introduction

The API is organized around actions. Our API has predictable, action-oriented URLs, and it accepts JSON request bodies and returns JSON-encoded responses.

Regarding the HTTP verbs, we use exclusively POST requests to request the platform to perform any side-effect action. We use GET requests to retrieve data from the platform without producing any side-effect.

Below is a list of the various HTTP Status Codes and what they mean:

  • 200 OK - The request was received and processed completely or partially.
  • 40X Client Error - The request is malformed or invalid. The response will contain the details of the error.
  • 500 Internal Server Error - The request was received and processed completely or partially, but there was an error in the platform. The response will contain the details of the error.

Notes:

  • The system will return a 200 OK response for any request that is received and processed completely or partially. The response will contain the details of the error.
  • The API actions are versioned. The version is included in the URL of the request, and, as a policy, we avoid breaking changes in the API at all costs. If we need to introduce breaking changes, we will introduce a new version of the action and keep the old one for retro compatibility. Any major change in the API will be announced in advance to all clients.

Base Integration

Any basic integration requires these Use Cases:

FAQ

  • What is the difference between the DEMO environment and the PRODUCTION environment? The DEMO environment is a sandbox environment where you can test the API and the integration with receeve. The PRODUCTION environment is the actual environment where you will be able to send real claims to receeve.
  • How can I get access to the PRODUCTION environment? Once you have tested the integration within the DEMO environment and you are ready to go live, we will share your credentials for the PRODUCTION environment.
  • Is there any difference regarding the requests between DEMO and PRODUCTION? No, the requests are exactly the same. The only difference is the URL and the credentials.

Related Pages