The base URLs to the Younium API are:
The reference is for Sandbox API URL but the same endpoints are available to use with Production endpoints.
Note: From here on in the API section, all examples will be using the sandbox base URL. For production replace the sandbox base URL with the production one.
Using Younium API
The Younium API is a rest API using json data. In general, the following Http verbs are used:
Updates to data in Younium are made using the concept of patching. This means that only the data (fields) provided in the patch request are updated in the target entity, all other fields on the entity remains as they were (except when a change of a field triggers changes to other fields, such as calculated/aggregated values, statuses, etc.).
All requests to the Younium API should have the following Http headers
Authorization: Bearer [access token from auth]
Postman example of headers for a request to Younium API:
The v2 API has different versions. The 2.0 version gives all objects in a response from a get request, while in 2.1, the standard is set to 20 objects and you can use paging, filtering, and orderby.
Here are some examples to add to the URL in v2.1:
?PageNumber=1&PageSize=10&Orderby=accountNumber desc&filter=accountNumber eq 'A-001603'
?PageNumber=1&PageSize=10&filter=version gt 3 and version lt 5 and orderDate gt DateTime'2020-01-01'
To specify the version in your API request, specify it in the request header:
Younium also has an active Classic REST API, that is in the process of being replaced with the endpoints above. You can find some documentation on them here:
There is also an API reference available here: