Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 81 Next »

API stands for Application Program Interface, and is a set of routines, protocols, and tools for building software applications.The call structure of the APIs is as follows:

  • Method HTTP is the format used to enable communication between clients (like Web browsers) and servers. The most common methods are GET, POST, PUT and DELETE.
    For more information on HTTP, see: HTTP Specification.
  • URL The Web address. The URL host is the Vibes public API site.
  • Header A unit of information that contains information about the file. Vibes APIs use a JSON file.
  • Body Represents the body of the request or response and allows you to declare what the content type is and how it should be handled.

Example API

POST
http://public-api.vibescm.com/companies/ABC123/campaigns/acquisition/abc123/participants/
Headers
Content-Type:
Application/JSON
Authorization:
Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
BODY
{
   "external_person_id":"EXT542342",
   "mobile_phone":{
      "mdn":"2995551234"
   },
   "custom_fields":{
      "first_name":"John",
      "last_name":"Doe"
   }
}

REST API Tree URI Structure

  • /companies [ G ]
    • /companies/:id [ G ]
      • /companies/:id/heartbeat [ G ]
      • /companies/:id/mobiledb
        • /companies/:id/mobiledb/persons [ S,P ]
          • /companies/:company_id/mobiledb/persons/:person_id  [ G,U ]
            • /companies/:company_id/mobiledb/persons/:person_id/subscriptions [ G ]
              • /companies/:company_id/mobiledb/persons/:person_id/subscriptions/:subscription_list_id  [ G, D, U? ]
        • /companies/:id/mobiledb/subscription_lists [ G ]
          • /companies/:id/mobiledb/subscription_lists/:id [ G ] 
        • /companies/:id/mobiledb/broadcasts [ S,P  ]
          • /companies/:id/mobiledb/broadcasts/:broadcast_id [ G,U,D? ]
      • /companies/:id/campaigns
        • /companies/:id/campaigns/acquisition [ G ] 
          • /companies/:id/campaigns/acquisition/:id [ G ]
            • /companies/:id/campaigns/acquisition/:id/participants [ S,P]
        • /companies/:id/campaigns/wallet [ G ] 
          • /companies/:id/campaigns/wallet/:id [ G ] 
            • /companies/:id/campaigns/wallet/:id/items [ G ] 
              • /companies/:id/campaigns/wallet/:id/items/:item_id [ GU ] 
            • /companies/:id/campaigns/wallet/:id/messages [ S,P ] 
              • /companies/:id/campaigns/wallet/:id/messages/:message_id [ G ] 
      • /companies/:id/incentives
        • /companies/:id/incentives/pools [ G ]
          • /companies/:id/incentives/pools/:pool_id [ G ]
            • /companies/:id/incentives/pools/:pool_id/issuances [ P ]
        • /companies/:id/incentives/codes
          • /companies/:id/incentives/codes/:code [ G ]
            • /companies/:id/incentives/codes/:code/issuances [ G ]
            • /companies/:id/incentives/codes/:code/redemptions [ G, P ]
      • /companies/:id/events [ P ] 
      • /companies/:id/config
        • /companies/:id/config/callbacks [ G,S,P ]
          • /companies/:id/config/callbacks/:callback_id [ G,D ]
  • /heartbeat [ G ]

 

 

  • No labels