To register your new service, the InAcademia Service requires some administrative data, and needs to validate some of your technical configuration.
This page describes the procedure you need to follow.
Information to be provided
Please send an email to firstname.lastname@example.org with the following information:
We need some administrative data to contact you in case of technical issues:
- Technical contact
Please provide us with a name and email (preferably not a personal email) of the technical contact of the service your are registering.
- EU based service
Please inform us if your service is handling personal data in or outside the EU
- Client status
Please let us know if the service you are connecting is a test instance or a production instance.
To connect a new service, the InAcademia service needs to be able to validate some parts of your configuration:
Please provide us with a client ID for your application. A valid client ID has at least 8 characters, and no special characters. If you anticipate using more than one client, e.g. for testing purposes, please note each instance requires a different client ID. It is suggested to choose client ids accordingly.
- Client Secret
A client secret is *not* used by InAcademia. You may send a Client Secret if your implementation requires you to, but it will be ignored.
- RedirectURI (callback URL)
Please provide us with the callback URL of your application. This is the URL where InAcademia will respond to your request after validation took place. The RedirectURL and the ClientID are tightly coupled, and must match the data registered at the InAcademia service.
To secure communications between the InAcademia service and the clients, the use of a *valid* https certificate for the RedirectURL is *mandatory*.
Free certificates may be obtained at LetsEncrypt, though for production platforms it is probably a better idea to register a longer lived certificate at a certificate authority of your choosing.
Validation of the information
When we have received your data, we will proceed with validating it.
As part of this validation, you must prove that you own the domain of the RedirectURL. To do so, the InAcademia support team will send you a challenge: a string value which you must incorporate into your configuration so it can be validated.
We support 2 options to prove the domain is yours, assuming the challenge provided is for example “4c69da58bccff54feb90b70d0fa33518e93e1d6e9d6f9dc97f256f9b18f6f4e0”
- Create a file named 4c69da58bccff54feb90b70d0fa33518e93e1d6e9d6f9dc97f256f9b18f6f4e0 with the following content:
validation-code = 4c69da58bccff54feb90b70d0fa33518e93e1d6e9d6f9dc97f256f9b18f6f4e0
- Place it on the root of the domain: yourdomain.com
Make sure the proper link is not broken, and can be reached from the Internet: https://yourdomain.com/4c69da58bccff54feb90b70d0fa33518e93e1d6e9d6f9dc97f256f9b18f6f4e0
- An HTTP(S) request to that resource should return an HTTP(S) 200 response
- Add the challenge to a TXT record of your domain: 4c69da58bccff54feb90b70d0fa33518e93e1d6e9d6f9dc97f256f9b18f6f4e0
Note the challenge will be a unique string each time, so copying the example string from this page will not work, you must use the challenge provided to you by InAcademia support!
The InAcademia service will notify you when the validation succeeded and the connection is active.