API Docs

Introduction

Welcome to Wobaka's JSON API documentation. You can use this to get, create, edit and delete your contacts. Pretty sweet right?

API Key

You can find your API key on the settings page.

Authentication & Content-Type

All requests are made as the user of the authentication api key being used. In case your api key is invalid we will return a HTTP 401 status code.

All requests are to be made to https://api.wobaka.com.

Example: Add new signups to Wobaka

Adding new signups to Wobaka is a breeze. When someone signs up, make an API call to the contacts endpoint. With just a few lines of code your CRM is in sync with your app:

POST /contacts
Authorization: Bearer <api_key>
Content-Type: application/json
{name: 'Signup Name', email: '[email protected]', company: 'Signup Co'}

GET /contacts

Will return a list of all contacts accessible to the user.

GET /contacts
Authorization: Bearer <api_key>
Content-Type: application/json
[{id: 1, name: 'Fredrik', email: '[email protected]' ...}]

GET /contact/:id

Will return a single contact by id.

GET /contacts/1
Authorization: Bearer <api_key>
Content-Type: application/json
{id: 1, name: 'Fredrik', email: '[email protected]' ...}

POST /contacts

Will create and return a new contact, if valid.

POST /contacts
Authorization: Bearer <api_key>
Content-Type: application/json
{name: 'Fredrik', email: '[email protected]', company: 'Wobaka' ...}
{id: 1, name: 'Fredrik', email: '[email protected]' ...}

PUT /contacts/:id

Will update and return a contact. Expects to receive a contact with modified fields where id is required.

PUT /contacts/:id
Authorization: Bearer <api_key>
Content-Type: application/json
{id: 1, name: 'Foo Bar', email: '[email protected]' ...}
{id: 1, name: 'Foo Bar', email: '[email protected]' ...}

DELETE /contacts/:id

Will delete contact by id and return HTTP status 200 if successfull.

DELETE /contacts/:id
Authorization: Bearer <api_key>
Content-Type: application/json

What about notes, tasks and opportunities?

It's coming. I had to start somewhere. Meanwhile, I won't hold you back from experimenting on your own.