Profiles from your own server

Help · Automation

A service of your own (an upload panel, a CRM, a farm) can drive your GetAntik: create a profile with a proxy and cookies, start it, stop it. The service sends a request to the server; the app takes it and carries it out on your computer. For creating, the app does not have to be running: the request waits for it. You need an account API key.

Create a profile

1. POST https://api.getantik.com/v1/remote/profiles with the header Authorization: Bearer antik_… and a JSON body: name, proxy, cookies, optionally platform (windows | macos | linux), group, tags, notes, start, device.
2. The 202 answer carries profile_id right away — the id the profile will have, used later to start and stop it — plus request_id, sealed (the request is sealed with the account key) and app_online (the app is connected right now).
3. If GetAntik is running and signed in to this account, the profile appears within seconds; with start: true it opens at once.
4. If the app is closed, the request waits. At the app's next start the profile is created but not opened — otherwise every window that piled up would open at once.

Start and stop

POST /v1/remote/profiles/{profile_id}/start and POST /v1/remote/profiles/{profile_id}/stop. They work only while the app is connected: otherwise the answer is 409 app_offline and nothing is queued. The answer is 202 with request_id; the result is in the request's status.

Request status

GET /v1/remote/requests/{request_id} → kind, status (pending | done | failed), profile_id, error with the reason. GET /v1/remote/requests?status=&profile_id= lists the latest requests; DELETE /v1/remote/requests/{request_id} withdraws one the app has not taken yet.

Cookies and proxy

cookies is text in the JSON-array format (as Cookie-Editor exports) or Netscape cookies.txt, up to 1 MB; they are set at the profile's first launch. proxy is any notation the app accepts: scheme://user:pass@host:port, host:port or host:port:user:pass. A bad proxy or bad cookies give the status failed with the error text.

Login, password and 2FA

autofill is a list of { label, value } entries: a caption and the value the extension types into any field on a right click; the account's login and password go as two such entries. totp is a list of 2FA keys { label, secret, digits, step }: the secret in base32 as the site issues it, digits and step default to 6 and 30. The codes show on the profile's start page and in the extension. All of it is sealed together with the cookies. From version 0.1.51.

Security

Cookies are your signed-in session. If the account has encryption on, the server seals the request with the account's public key the moment it arrives, and only your app can read it; the answer says sealed: true. Without encryption the request is stored in the open until the app takes it.

Several computers

If the app is open on several devices, the first one to connect takes the request. To have the profile created on a particular computer, pass device — the device name as shown in Settings → Account.

Sign-up from a service

A partner service holding an integration key can register an account for its user with one call: POST /v1/integrations/register with Authorization: Bearer int_… and the body { email, language }. The user receives a letter with the login and password; the service receives the account's api_key for the requests above. If the e-mail is already registered, the answer is 409 email_taken: the user then creates an API key in Settings → API keys and hands it to the service. Integration keys are issued by GetAntik support.

Possible errors