To develop using this service you'll need a username, password, SubscriberID and one or more APIKeys.
- Username and Password authenticate you or your users to the service (your users will get their own username/passwords later)
- SubscriberID is an integer distinguishing your visit links from others that would be identically named. This value is assigned to you when you sign up.
- APIKeys are used to manage or decline access to faulty user-agents and indicate privileges peculiar to your account, and those of your users.
The username must be between 2 and 32 unicode characters long (the set of ascii characters is included in unicode)
Usernames are case-sensitive, so 'Edward' and 'edward' would both point to different accounts. Usernames are not currently visible to other users, but this could later change.
If the password is ascii-only, it must be between 8 and 32 characters long, containing at least one upper-case, one lower-case and one numeral.
If the password contains any extended ascii or any non-ascii unicode characters, it need only be between 8 and 32 characters long - the uppercase/lowercase/numeral requirement is waived.
The APIKey "note" field is freeform text used to remind you later what the APIKey was intended for; you may wish to use the project name & version here.
Developers can obtain an account and first APIKey here.
Non-developers can sign up here.
APIKeys can be obtained here.
The csi18n service attempts to be RESTful. A feature of such services is that they don't do sessions: you don't log in, do work, and log off: you send a request, you get a response, and that's it. As such, you'll send the above username, password and APIKey along with every request. They are secured in transmission by this service only accept HTTPS connections.