API

The JSON API can be used to programmatically create JumpWords and to retrieve the messages. You will need an API key to create JumpWords, however no API key is needed to retrieve messages as all JumpWords are public. You can create up to 5 API keys.

API Keys

You need to Sign in to view or create API keys.

Using the API

Create

Perform an HTTP POST with your message and API key to create JumpWords which will be associated with your login.

curl -X POST https://jumpwords.com/api/create \
     -H "Content-Type: application/json" \
     -H "Authorization: ApiKey <your-api-key>" \
     -d '{"text": "This is a message"}'

{"jumpwords":"arm dive well","text":"This is a message"}

View

Perform an HTTP GET with your JumpWords to retrieve your message. An API key is not required as all JumpWords are public. JumpWords can be separated with spaces, likely urlencoded as %20, or if more convenient, they can be separated with "." (full stops).

curl "https://jumpwords.com/api/view?jumpwords=arm%20dive%20well"

OR

curl "https://jumpwords.com/api/view?jumpwords=arm.dive.well"

{"jumpwords":"arm dive well","text":"This is a message"}