Description
This knowledge article contains information on how to generate the Service Provider API user manuals.
Important Notes
1 - DO NOT SHARE ANY OF THESE API's WITH END-USERS, THEY SHOULD BE ONLY FOR SERVICE PROVIDERS
2 - As updates can be done on each confluence page, please export always export the latest version, this will assure you are providing updated information for the service provider.
3 - DO NOT SHARE THIS PAGE https://ruptela.atlassian.net/wiki/spaces/RnD/pages/4594303/Raw+data+API
To whom this can be shared?
These API's can only be shared with Service Providers
Is NDA needed?
No, but before sending these manuals or generating the API key it is worth always to ask sales manager for confirmation, because sales manage may bill clients additionally.
What is needed for Service Provider to consume each API?
The service provider must have a Service Provider API key to consume each API.
Here is how to generate this Key: https://ruptela.atlassian.net/wiki/spaces/RnD/pages/4595445/Service+provider+API+key+generation
Available API's for Service Provider
Currently, there are 7 APIs available, but in the future, there can be more. So, please check if there are additional API's available in this list:
How to generate a PDF file from any given user manual
Click on one of the given manuals listed above
Click on the left three dots
Click on Export
Click on Export to PDF
A new page will open, click on download PDF
The file will be downloaded and available on your computer
Repeat the process from Step 1 for all the necessary API's