| Coachview is an online software package for course administration. In addition to registering, for example training courses, companies and persons and registrations in Coachview, it is also possible to access data from Coachview. You can do this by using API's (Application Programming Interface), a kind of contract of services between two applications. |
 |
Opportunities: |
| Coachview has two environments available to connect your API's to. The production (live) environment and the training (playground) environment. In the training environment you can develop and test your API's. Tests in training do not affect the live data. But beware! Periodically, the training environment is overwritten with data from the live environment, whereby not all data are transferred one-to-one. This happens when installing a new release in this environment. Want to know more about when new releases are installed? Click here for the installation schedule. Want to know which data will not be included? Then click here for an overview. You use the live environment to retrieve or write out current data. After successfully testing the API links in the training environment, you can get started in your live environment. The API's are offered based on a 'Fair use policy'. This means that your use of the API's should not affect the performance for other customers. It is important to think carefully about which API's are needed to achieve the desired result. Do you have any question about this or would you like us to think along with you? Please contact us. |
Documentation: |
| Because there may be a difference between the training environment and the live environment, we have created a separate documentation page for both environments. New API's and modifications to existing API's will be added first in the training environment. Curious and want to know more? Then click here for the documentation page. You will be using Swagger. |
Authorization: |
| Before you get started, it is important to know what permissions you need and how to make sure you can test the API's in the two different environments with Swagger or use them through Postman. |
| To test the different API's via Swagger or use them via Postman, you need a Coachview user account in the training environment and/or the live environment. Depending on the API's you will be testing, you need administrator rights and read and write rights on different modules. Which modules are necessary depends on the API's you want to use. For the live environment, a user account requires a monthly license fee, depending on the modules set up. |
PublicId: |
| To retrieve information from records, you can use a publicid. This is a secure and untraceable number. If you are still using our SOAP web services, then you are used to using internal id's which is less secure. So it is advisable to switch to our REST API's. Using a translation service you can make the translation between the internal id and the PublicId. |
Costs: |
| There are monthly fees for using our API's. |
Questions: |
| If you have any questions, please contact our support department, send an e-mail to [email protected]. |
 | Please note that it will never be possible to test with Swagger in the live environment! The Swagger page of the training environment may be different from the Swagger page of the live environment because new additions become available on training first. |
