general information

CryptAES API Version 1

The stable HTTP endpoint for the latest version is:

https://www.cryptaes.com/api/v1/

User

Top

Supports registering, viewing, and updating user accounts.

Register a new user account
Request:
https://www.cryptaes.com/api/v1/users/
Parameters:
Name Type Description
username string The username for the new user
password string The password for the new user
Note:

NOT Authorization Protected

Response:

                    Content-Type application/json
                    201 Created

                    {
                    "id": "5d5f9gae-a55b-3b4b-82c4-3654eda6b096",
                    "username": "john",
"password": "pbkdf2_sha256$242$o2flVfk42$o2flVfk42$o2flVfksXhv$/r50=", "auth_token": "18c637775765904ad3b6545df3e5d87eca25bd2e" }

The `auth_token` returned with this response should be stored by the client for authenticating future requests to the API.

Crypt URL

Top

Support encrypt a URL.

Create one link encrypted
Request:
https://www.cryptaes.com/api/v1/crypto/https://www.domain.com/encrypt/
Note:

Authorization Protected

No additional parameters required. Only on URL

Response:

                    Content-Type application/json
                    201 Created

                    {
                    "status": "success",
                    "string": "5t0G",
                    "url": "https://www.cryptaes.com/decrypt/542$o2f42$o2flVfklVfkt042$o2flVfkG/"
                    }

                

Authentication

Top

For clients to authenticate, the token key should be included in the Authorization HTTP header. The key should be prefixed by the string literal "Token", with whitespace separating the two strings.
For example:

Authorization: Token 9944b09199c62bcf9

Unauthenticated responses that are denied permission will result in an HTTP `401 Unauthorized` response with an appropriate `WWW-Authenticate` header.
For example:

WWW-Authenticate: Token

Retrieving Tokens

Authorization tokens are issued and returned when a user registers. A registered user can also retrieve their token with the following request:

Request:
https://www.cryptaes.com/api/v1/api-token-auth/
Parameters:
Name Type Description
username string The username for the new user
password string The password for the new user
Response:

                    Content-Type application/json
                    201 Created

                    {
                    "token" : "942$o2flVfk44b091942$o2flVfk9c62bcf42$o2flVfk941"
                    }