API
Public API overview
Other software can read the description and apply for one-click sign-in or an SDK. An application returns a reference right away. We do not issue a sign-in session for Koder, and there is no official model to call.
1 / 2
Four addresses
The base URL is https://karmenloop.com. The machine-readable description is at /api/public/v1.
Read the description
GET /api/public/v1 is open. It returns the endpoint list, the status of each one, and account sign-in as Not open. It does not need an invite code.
Submit an application
POST /api/public/v1/applications is open. The product name is at most 80 characters, the site and the callbacks must be https, and the description is at most 500 characters. On success the status is Received, with a reference that starts with app_.
User confirmation and tokens
GET /api/public/v1/oauth/authorize and POST /api/public/v1/oauth/token return Not open. A reference cannot be exchanged for a token.
What an application has to include
- One-click sign-in needs 1 to 5 https callback addresses. http and local addresses are not accepted. An SDK application does not need a callback.
- The contact email has to pass a basic format check, and it is at most 120 characters. The site is at most 200 characters.
- The reference is created on the spot. The application is not stored as a record you can look up later, and you cannot use the reference to retrieve what you submitted.
- A bad field returns 400 and a fixed reason. If the body cannot be read, that is also 400.
The steps and examples are in the docs. The two addresses that are not open are on Access.
Do not mix this up with the account page in the app
The account page in the app says there is no cloud account, and the profile stays on this computer. It has no Create a token button. All four public addresses are on karmenloop.com: reading the description is open, submitting an application is open, and user confirmation and token exchange return Not open.
An application needs a product name (at most 80 characters), an https site, a contact email, a kind (one-click sign-in or SDK), and a description of at most 500 characters. One-click sign-in also needs 1 to 5 https callbacks. Success returns 201 and a reference. The reference cannot be used to look up what you submitted.