Menu

API Entry Point (AEP)

The AEP is the top-level entry point for Action Builder's API. It provides links to the campaigns resource. By starting at the AEP and following successive links, an API user should be able to reach all URLs available on the API.

Endpoints and URL Structures


https://[your-sub-domain].actionbuilder.org/api/rest/v1/

The AEP is located at the above link, and all collections and resources stem from that basic URL structure.

URL Structures:


https://[your-sub-domain].actionbuilder.org/api/rest/v1/[resource_type]

To address a specific type of resources, use the resource type name like:


https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns
Back To Top ↑

Field Names and Descriptions

API Entry Point Fields

Field Name Type Description
motd string An informational message from the server.
vendor_name string The name of our system, always "Action Squared, Inc.".
product_name string The name of our product, always "Action Builder".
osdi_version string The version of the OSDI specification that we conform to. Currently "1.2.0".
max_page_size string The maximum number of resources that will be returned by the server when using GET on a single page in a collection of resources. Currently 25.
namespace string The string we use to namespace our custom API endpoints and curies. Currently "action_builder".

Back To Top ↑

Related Resources


Back To Top ↑

Scenario: Retrieving the API Entry Point Resource (GET)

Calling the AEP link will return the API entry point resource.

Request

					
GET https://techworkersunited.actionbulider.org/api/rest/v1/

Header:
OSDI-API-Token: your_api_key_here

Response

			 	 
200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate					 
					 
{
 "motd": "Welcome to the Campaign Test Action Builder API Entry Point!",
 "vendor_name": "Action Squared, Inc.",
 "product_name": "Action Builder",
 "osdi_version": "1.2.0",
 "max_pagesize": 25,
 "namespace": "action_builder",
 "_links": {
   "self": {
     "title": "This API entry point",
     "href": "https://techworkersunited.actionbuilder.org/api/rest/v1"
   },
   "docs": {
     "title": "Documentation",
     "name": "Docs",
     "index": "index",
     "href": "https://actionbuilder.org/docs/v1/"
   },
   "action_builder:campaigns": {
     "title": "The collection of campaigns in the system",
     "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns"
   },
   "curies": [
     {
       "name": "osdi",
       "href": "https://actionbuilder.org/docs/v1/{rel}",
       "templated": true
     },
     {
       "name": "action_builder",
       "href": "https://actionbuilder.org/docs/v1/{rel}",
       "templated": true
     }
   ]
 }
}

Back To Top ↑

Scenario: POST/PUT/DELETE

Posting, putting, and deleting on the AEP is not allowed. Attempts will result in errors.


Back To Top ↑