Read the description
GET /api/public/v1
Returns the list of endpoints, and which ones are open.
Developers
Public API and the setup guide
Other software can call Koder’s public API and apply for one-click sign-in or an SDK. Below is what you can call today, how to apply, and the order to follow.
1 / 2
Public API
The base URL is https://karmenloop.com. The machine-readable description is at /api/public/v1.
Submit an application
POST /api/public/v1/applications
Apply for one-click sign-in or an SDK. A successful request returns a reference right away, with the status Received.
User confirmation
GET /api/public/v1/oauth/authorize
POST /api/public/v1/oauth/token
You can call both addresses. Both return Not open. A reference cannot be exchanged for a token.
Setup guide
Do it in this order. Until the review has passed, do not show people who use your software a sign-in button that looks like it will succeed.
- Have a product name, an https site, a contact email, and a short description.
- For one-click sign-in, also have 1 to 5 https callback addresses. A local address or an http address is not accepted.
- Call the application endpoint, or use the form on this page. Save the reference you get back.
- After the review passes, we email the authorization address and the connection details to the address you left. Until then, the authorization address and the token endpoint both return Not open.
- After the review passes, point the button at the authorization address we sent you. After the person confirms in the browser, they return to the callback you registered, with a one-time code.
- Exchange that code at the token endpoint. Keep the token on that computer. Do not put it in page source, and do not use it to read a model key.
A one-click sign-in request
curl -X POST https://karmenloop.com/api/public/v1/applications \
-H 'content-type: application/json' \
-d '{"productName":"Example app","site":"https://example.com","contact":"dev@example.com","kind":"one-click-login","redirectUris":["https://example.com/callback"],"summary":"One-click sign-in for people who use the app"}'An SDK request
To call Koder on this computer from your own program, use Koder SDK 0.1.1. The application below is for the public API, not that repository. Change kind to sdk, and say which public calls it will make. An SDK application does not need a callback address.
curl -X POST https://karmenloop.com/api/public/v1/applications \
-H 'content-type: application/json' \
-d '{"productName":"Example SDK","site":"https://example.com","contact":"dev@example.com","kind":"sdk","summary":"Call Koder’s public API from our own software"}'Not here yet
- Koder has no account sign-in. The account page says there is no cloud account. You do not need to register to use Koder.
- A reference is not an access token, and you cannot sign in with it.
- The public API does not hand out model keys, and it does not sign in to someone else’s software for you.
Apply here
The form sends the same fields as the endpoint above. After you submit, the page shows the reference.
The docs describe the site, not a page inside the app
There is no public-API console inside the Koder window. Settings → Account and profile says there is no cloud account. The bottom of the sidebar says local use, not signed in, not syncing. What a third party connects to is the public API on this site: read the description, and submit a one-click sign-in or SDK application. An application returns a reference that starts with app_ right away, with the status Received.
The reference is only a receipt. It is not stored as a record you can look up later, and it cannot be exchanged for a token. The authorization address and the token address return Not open. Account sign-in is not available, so there is no user session to grant.