Getting Started with Partners API

Welcome to Suntransfer's API documentation

The purpose of this guide is explaining the basic functionality of the API and learn how to use it efficiently.

How changes flow

Changes will come to the API frequently. The API is JSON based and RESTFUL so it is very important to understand the possible changes and how to deal with them.

The versions will be marked as MAJOR.MINOR.PATCH

For example, 1.2.1

PATCH: we will increase the patch number every time there is a change that does not require modifications on the current integrations.

Examples:

Performance improvements
Bug fixing
Adding attributes on the JSON

🚧
Adding attributes on the JSON
The purpose of working with JSON is to have the ability to expand the document without affecting the consumers.
If the JSON processing is done right, should be resistant to have more attributes, without any modifications on the existing ones.

MINOR: we will increase the minor number when there are new methods available. In this type of upgrades, no method will be deleted or changed.

MAJOR: when there is a major version, a new URL will be created and will coexist with the current one for a long period of time (12 months).

For example, if your code is working with version 1.2.1. Your url will look like /v1/someaction. When we push to production version 2.0.0, a new url will coexist: /v2/someaction. Then the adaptation period (12 months) will start. After 12 months, we will not guarantee that v1 will still work.

👍
Release page
All releases will be announced on our Changelog page.

Testing

The API reference is meant to work as a sandbox. It is safe to do tests there. All the data is reset each midnight (Barcelona time).

👍
Going to production
When you feel confident going to production, contact us.

Getting credentials

Sunstransfers will provide an username and a password to authenticate to the API. Those credentials will work both in staging and production. Make sure you have it before going deep into the API Reference or the working example.