Get Started
In this guide, you are going to learn how to interact with sections as a frontend developer. If you are a vueJS dev you can use our ready made vue-sections library.
If you wish to create your own client implementation, keep reading.
Step 1: Register here to get your project_id.
Step 2: With your project_id you can start requesting sections yet to create pages and add content to them you need an access token. Read below to understand how to get an access token for your project.
Note: All requests that are secured by a Section token is subject to CORS verification
API's base URL is https://sections.geeks.solutions
Models
Dashboard
Dashboard information returned that conveys package limitations and current consumption
{
"package_name": "free",
"package_locked": false,
"max_pages": 2,
"max_media_files": 10,
"max_file_size": 500000,
"current_pages": 0,
"current_medias": 0,
"api_until_reset": 46674951,
"api_limit_use": 500,
"api_current_use": 0
}
| Property | Description | Type | Required |
|---|---|---|---|
| api_current_use | current rate limtied requests ina specific day | boolean | true |
| api_limit_use | Maximum allowed rate-limited requests in a specific day - Package limitation | string | true |
| api_until_reset | Timestamp in milliseconds until the API rate-limited consumption is reset | integer | true |
| current_medias | Count of total files currently present linked to pages of this project. | integer | true |
| current_pages | Count of number of pages currently created in the project. | integer | true |
| max_file_size | Maximum allowed file size (in bytes) that can be used in pages of this project - Package limitation. | integer | true |
| max_media_files | Maximum allowed files that can be present linked to pages of this project - Package limitation. | integer | false |
| max_pages | Maximmum number of pages that can be created in the project. - Package limitation | integer | true |
| package_locked | The package's locked status the project is subscribed to. | boolean | true |
| package_name | The package's name the project is subscribed to. | string | true |
Error
Errors returned by sections
{
"error": "Section type already exists"
}
| Property | Description | Type | Required |
|---|---|---|---|
| error | Description of the error | string | false |
Invitation
This is the response of the invitation API call.
{
"invited": [
"email1@gmail.com",
"email2@gmail.com"
],
"failed_to_send": [
"email3@gmail.com"
],
"demotion": [
"superiorrole@gmail.com"
]
}
| Property | Description | Type | Required |
|---|---|---|---|
| demotion | List of emails that are already in the project and have a superior role to the invitation one. | array(any) | false |
| failed_to_send | List of failed invitation emails | array(any) | false |
| invited | List of successfully invited emails | array(any) | false |
Media
A media is an entity that presents a file in Sections
{
"type": "image",
"seo_tag": "",
"private_status": "public",
"number_of_contents": 1,
"namespace": "608c0177d66ef2000836a374",
"locked_status": "unlocked",
"id": "613874bc0a998613c74b338c",
"files": [
{
"url": "https://s3.amazonaws.com/eweevtestbucketprivate/sections%2Fa5ac5bc7e6d643f89a4f15c4d8f29aec89ba3988ab904d6aae5934719d4df19a.png",
"type": "image/png",
"thumbnail_url": "https://s3.amazonaws.com/eweevtestbucketprivate/sections%2Fa5ac5bc7e6d643f89a4f15c4d8f29aec89ba3988ab904d6aae5934719d4df19a_thumbnail.png",
"size": 25442,
"platform_id": "611610df0a998615afb99c29",
"filename": "sections/a5ac5bc7e6d643f89a4f15c4d8f29aec89ba3988ab904d6aae5934719d4df19a.png",
"file_id": "ac411a0825cd280cc219844bf3b64271-12de37"
}
],
"contents_used": [
"60cb6953d66ef20008ae2177"
],
"author": "60cb6953d66ef20008ae2177"
}
| Property | Description | Type | Required |
|---|---|---|---|
| author | The author of the media | string | false |
| contents_used | List of pages related to this media | array(any) | false |
| files | List of files | array(any) | true |
| id | Unique identifier | string | true |
| locked_status | unlocked media can be edited by any user in the project. locked medias can only be edited by their author |
string | false |
| namespace | The project id using this media | string | false |
| number_of_contents | The number of contents referencing this media | integer | false |
| private_status | public files are accessible by anyone, private files requires an STS token to be viewed |
string | false |
| seo_tag | Image Alt tag used for SEO | string | false |
| type | Media type (image, video..) | string | false |
Message
A confirmation message back to the user upon successfull action
{
"message": "Section type deleted succesfully"
}
| Property | Description | Type | Required |
|---|---|---|---|
| message | a message | string | false |
Options
Options returned by third party applications for a configurable section type
[
{
"option_values": [
1,
2,
3
],
"field": "article_ids"
}
]
| Property | Description | Type | Required |
|---|---|---|---|
| error | Array of options with their possible values | array(any) | false |
Package
A package is the subscription of your project in section. It represents what the project is offered in term of resources.
{
"type": "public",
"rank": 1,
"quota": -1,
"price": 1700,
"name": "solo",
"locked": false,
"limits": [
{
"value": 5,
"name": "number_of_pages",
"label": "Max number of pages"
},
{
"value": 3,
"name": "variation_per_page",
"label": "Max number of variation per page"
},
{
"value": 20,
"name": "static_sections",
"label": "Max number of static section types that can be declared"
},
{
"value": 10,
"name": "sections_total",
"label": "Max number of sections per page"
},
{
"value": 100,
"name": "hosted_files",
"label": "Max number of files hosted"
},
{
"value": 1000000,
"name": "size_per_file",
"label": "Maximum Size Per File (in bytes)"
},
{
"value": -1,
"name": "api_limit_sec",
"label": "API rate limit per sec"
},
{
"value": -1,
"name": "api_limit_minute",
"label": "API rate limit per minute"
},
{
"value": 500,
"name": "api_limit_hour",
"label": "API rate limit per hour"
},
{
"value": 1000,
"name": "api_limit_day",
"label": "API rate limit per day"
}
],
"label": "Standard"
}
| Property | Description | Type | Required |
|---|---|---|---|
| id | Unique identifier | string | true |
| label | The title of the package | string | false |
| limits | A list of limits, it shows up to how much resources can your project consume | array(any) | false |
| locked | Whether this package is locked and can receive new subscriptions or not | boolean | false |
| name | Unique name of the package | string | false |
| price | The price of the package in cents (ie 10,50€ is returned as 1050) | integer | false |
| quota | The number of projects allowed to use this package at any given time. -1 for unlimited | integer | false |
| rank | The package rank used to identify upgrades/downgrades between packages | integer | false |
| type | The type of the package could be private or a public one. | string | false |
Page
A page is layout of different sections grouped together.
{
"variations": [
"variation-1",
"variation-2"
],
"settings": [
{
"weight": 1,
"type": "dynamic",
"region": "bottom-left",
"name": "blogs:categories_articles",
"id": "123456789123456789123456"
}
],
"project_id": "5fe309f42a4e7d91aad8964f",
"page": "home_page",
"layout": "layout1"
}
| Property | Description | Type | Required |
|---|---|---|---|
| id | Unique identifier | string | true |
| layout | The layout title | string | false |
| metadata | An object containing the metadata of your page | map | false |
| page | Name of the page | string | true |
| path | The path under your domain to access your page, it has to be unique per project. Equals to your page name if empty | string | true |
| render_data | Data requested by the front end developer that he will use to render the content needed. | string | false |
| settings | List of sections that are included in the page | array(any) | false |
| variations | A variations for the page | string | false |
Pending_Invitation
This is the response of the get pending_invitation API call.
{
"users": [
{
"role": "webmaster",
"invited_at": 1652524584,
"email": "email@gmail.com"
}
],
"total": 1
}
| Property | Description | Type | Required |
|---|---|---|---|
| total | Total of pending invitations | integer | false |
| users | List of pending invitations | array(any) | false |
Project
A Project that a user owns in sections it contains the project credentials and configurations
{
"type": "private",
"project_url": [
"https://your.project.url.com"
],
"private_key": "xxxxxx",
"package": "free",
"login_redirect_url": "https://your.project.url.com/redirect_login/admin",
"id": "601bf1221907a50007ba3f81",
"files_counter": 0,
"configured_fields": {
"blogs ": {
"project_id": 1,
"private_key": "xxxxxx"
}
},
"active": true
}
| Property | Description | Type | Required |
|---|---|---|---|
| active | The status of the project | boolean | false |
| billing_status | The Billing status of the project, can be any of upgrade_lock or upgradeable. |
||
| This is automatically set based on your company solvency status. | string | false | |
| configured_fields | A list of object (maps) that indicates the configured fields of the third party apps for this project | array(any) | false |
| id | Unique identifier | string | true |
| limitation_status | The Limitation status of the project, can be any of active, degraded or blocked. |
||
| This is automatically set based on your invoice payment status. | string | false | |
| login_redirect_url | The URL Sections redirects connected user to with the auth code to issue a valid access token. | string | false |
| package | The current subscription of the project | string | false |
| project_url | The list of base URLs of the project, used to pass CORS. You are allowed to use localhost in the list, as long as you specify the port.Local network IP Addreses are also allowed, only on HTTP and by specifying the port as well. | array(any) | false |
| reason | The reason of inactivity in case the project is inactive | string | false |
| type | The type of the project can be public or private | string | false |
Section_Type
A Section Type in Sections
{
"type": "static",
"name": "private_static",
"multiple": false,
"id": "60195bbd2a4e7df7496d9740",
"fields": "null",
"dynamic_options": false,
"application": "sections",
"access": "private"
}
| Property | Description | Type | Required |
|---|---|---|---|
| access | The access to the section type | string | false |
| application | application that declared the section type | string | false |
| authorization_fields | Used for third party integration to authorize the use who is asking for the section type | map | false |
| fields | Used for configurable Section Types fields that can be chosen to render | map | false |
| id | Unique identifier | string | true |
| name | Section type's name | string | false |
| options | Used for configurable Section Types options | map | false |
| region | The region of the layout that section type will be rendered into default to {}. | map | false |
| requirements | Shows the required fields for a public scoped section type. | array(any) | false |
| status | Shows the status for a public scoped section type. | string | false |
| type | The type of the sections i.e. static, local, configurable or dynamic | string | false |
| weight | The weight of the section type on the layout which means the order | integer | false |
Token
Certain API calls are secured with an access token, read below about authentication to know how to get an access token for your application
{
"token": "A really long string"
}
| Property | Description | Type | Required |
|---|---|---|---|
| token | An authentication token | string | false |
User
This is Section's user model. It contains all the information that sections needs to know about you.
{
"token": "A really long string"
}
| Property | Description | Type | Required |
|---|---|---|---|
| Users email | string | false | |
| roles | DEPRECATED. A list, contains the roles' IDS. | array(any) | false |
| roles_object | A lsit of objects. Each object contains the role title and id. These are the roles that are assigned tot he user. | array(any) | false |
| saas_project_id | The section project to which the user is linked to. | string | false |
1. Authentication
In order to issue secured api calls to sections you need an access token, to simplify the generation of such token we implemented a simple flow.
When you register or login successfully you will get redirected to the back office page of your project where you see your project information.
There is a field named Login Redirect Url you should populate it with the URL of a page on your project where you will run the Access Token retrieval code.
Next to the field, there is a button called Connect to your app with your sections credentials. When clicking this button you will get redirected to your website with an auth_code in the query string. This auth code is required to retrieve your access token from sections in the Get Access Token request.
Once you retrieve your token you have to include it in :ratethe header of the secured requests.
Get access token
Valid auth code/
GET /api/v1/project/649abdcd84307f02e1d4c567/token/F36F2EECA62C7B7498DD8A70441FD345
origin: http://8dbbafb1-1392-45b6-a317-99c04e371cb3.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEdXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmRjZDg0MzA3ZjAyZTFkNGM1NjdqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA1NjE0NGUzNzFkNDI0NjZmYjRkOGE0NjA0MTRjYzM5MW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAKWt1_IgBYgABUYA.bdVv5WYqujpsRBQVeJhg2t7CRCUo3FGANDIhGSgsOX8
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-Nrl3vV01EMYABBkB
access-control-allow-origin: http://8dbbafb1-1392-45b6-a317-99c04e371cb3.com
{
"token": "SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEdXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmRjZDg0MzA3ZjAyZTFkNGM1NjdqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA1NjE0NGUzNzFkNDI0NjZmYjRkOGE0NjA0MTRjYzM5MW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAKWt1_IgBYgABUYA.bdVv5WYqujpsRBQVeJhg2t7CRCUo3FGANDIhGSgsOX8"
}
Use a supplied auth_code to retrieve an access token. The auth_code expires in a few seconds, if you wish to test that using an API client (i.e Postman) make sure to act quickly.
Request
GET api/v1/project/{project_id}/token/{auth_code}
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| auth_code | An authentication code that will be returned on redirection when you login/register successfully | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | section type resource | Token |
| 410 | Error Resource | Error |
2. Working With Pages
A page is where you organize your sections in one or more layouts. In this part you will learn how to create/update/render and delete a page. Please refer to the page models to see all fields a page can contain.
Renders a page
Get an existing page
POST /api/v1/project/649abd6984307f02e1aea7de/page/page-path-fc07d84e-4385-4521-a92c-59f06db3bfb2
origin: http://ed1718a4-4ac6-4a8a-b693-d9db88d00c3e.com
user-agent: user-agent-807d9793-1fe7-4555-906b-17a03ba59d7c
project-id-afc6a943-637d-4e0f-9f7d-7b3055ae4a7a: 1
content-type: multipart/mixed; boundary=plug_conn_test
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-H55t5xMmZ4QABAnB
access-control-allow-origin: http://ed1718a4-4ac6-4a8a-b693-d9db88d00c3e.com
{
"variations": null,
"sections": [
{
"weight": 1,
"type": "static",
"settings": {},
"render_data": "",
"region": "main",
"name": "section_name_c110c405-5f5b-418d-899f-b07babf4c1fb",
"linked_to": "",
"id": "649abd6a84307f02e197785e",
"error": null
}
],
"path": "page-path-fc07d84e-4385-4521-a92c-59f06db3bfb2",
"page": "page_742e1904-35d1-402e-817a-ee0635e858ba",
"metadata": {},
"layout": "layout1",
"last_updated": 1687862634,
"invalid_sections": [],
"id": "649abd6a223160f5dd25d1b3"
}
Renders a page with all the available sections declared inside.
Request
POST api/v1/project/{project_id}/page/{page_path}
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| query_string | Query Strings | body | map | false | {id: 1} | |
| project_id | Your project id in Sections | query_string | string | true | ||
| page_path | The page path | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Project resource | Page |
| 404 | Error Resource | Error |
| 429 | Error Resource for rate limiting | Message |
Creates/updates a page
Create a page with valid section using medias ids
PUT /api/v1/project/649abd7184307f02e1391426/page/page_f89ac842-3e9d-436c-8f04-df5293252393
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEVXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmQ3MTg0MzA3ZjAyZTEzOTE0MjZqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA2MDYyMzNiMGFmMzc0ZDZmYWMxNzQ4MDFkYmIyNTNmY20AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAUgR0_IgBYgABUYA.NjR47tr-Pw7jTMjGuhixyvc7q_mlT7eeg-zS5R8VOoI
origin: http://04c4b74a-0fa0-4d82-b723-f72c9cda67c3.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"variations": [
"1"
],
"sections": [
{
"weight": 1,
"region": "main",
"options": [
{
"image": {
"media_id": "649abd7684307f02e1405b30"
}
}
],
"name": "section_name_86503d8c-b04c-4c03-80b1-030567dc457b"
}
],
"path": "my-page-path",
"metadata": {
"title": "Page Title",
"description": "Page SEO Description"
},
"layout": "layout1"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-IoXuHX9deA0ABAyh
access-control-allow-origin: http://04c4b74a-0fa0-4d82-b723-f72c9cda67c3.com
{
"variations": [
"1"
],
"sections": [
{
"weight": 1,
"type": "static",
"settings": [
{
"image": {
"url": "https://www.fake-url.com/edfc1963563d4c20b1213332337914a5",
"seo_tag": null,
"media_id": "649abd7684307f02e1405b30"
}
}
],
"render_data": "",
"region": "main",
"name": "section_name_86503d8c-b04c-4c03-80b1-030567dc457b",
"linked_to": "",
"id": "649abd7784307f02e102bcd9",
"error": null
}
],
"path": "my-page-path",
"page": "page_f89ac842-3e9d-436c-8f04-df5293252393",
"metadata": {
"title": "Page Title",
"description": "Page SEO Description"
},
"layout": "layout1",
"last_updated": 1687862647,
"invalid_sections": [],
"id": "649abd77223160f5dd25d287"
}
Upsert a page in your project with all the sections declared and their
configuration so when rendering the page the user gets the same result.
If you wish to create an empty page, simply supply an empty sections list in the payload.
For each section you can provide options.
In the options you can add files for you to use. In order to add a file for a static section type.
You need to add the fields that declare files in that section type. For ex:
{
"fields": [
{
"type": "image",
"name": "profile_image"
},
{
"type": "image",
"name": "cover_image"
}
]
}
Now in the options you can provide an existing media id to link to a section on a page.
"options": [{"profile_image": {"media_id": "media_id"}}]
For More details on Medias, please head to the Medias section below.
DEPRECATED: you can also provide the image like that:
"options": [{"profile_image": "A BASE 64 file string"}]
The base64 will be transformed into a media file on the fly. This method will be dropped in an upcoming update.
Request
PUT api/v1/project/{project_id}/page/{page_name}
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| page_name | The page name | query_string | string | true | ||
| token | Sections Token | header | string | true | ||
| variations | In case you need no Variations of the page send an empty list or null | body | array | true | {'variations': ['page1', 'page2']} | |
| sections | List of sections that are going to be rendered in the page | body | array | true | {'sections': []} | |
| layout | Layout title of the page | body | string | false | {'layout': 'main'} | |
| url | Url of the page as the Path to access it (ie https://www.example.com/{url}) | body | string | true | {'url': 'my-page-url'} | |
| metadata | Metadata of the page | body | map | false | {'metadata': {'title': 'My Page Title', 'description': 'SEO Description'}} |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Project resource | Page |
| 401 | Error Resource | Error |
| 402 | Error Resource | Error |
Deletes a page
delete a page
DELETE /api/v1/project/649abd6784307f02e10ab307/page/649abd67223160f5dd25d15a
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEVXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmQ2Nzg0MzA3ZjAyZTEwYWIzMDdqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA5YWZlYWQ1NzMzYmI0ZjU5YWMyMjIxMzIwMGU1YWVmMW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAd9tz_IgBYgABUYA.JNyfS2IZ6hFUUTwubszsVcszQFJQ2zb9-BEgmZk7hIU
origin: http://c63d8055-b12f-4c02-abb2-2ea9419520ec.com
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-HuqyzTyyOnMABAeh
access-control-allow-origin: http://c63d8055-b12f-4c02-abb2-2ea9419520ec.com
{
"message": "Successfully deleted 649abd67223160f5dd25d15a"
}
Deletes the page for your project. This call will erase all the data you have stored for the sections added in this particular page.
Request
DELETE api/v1/project/{project_id}/page/{page_id}
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| project_id | Your project id in Sections | query_string | string | true | ||
| page_id | The page id in Sections | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Project resource | Message |
| 401 | Error Resource | Error |
| 404 | Error Resource | Error |
3. Working With Section Types
### Sections supports four section types:
Local: This section type is totally declared and rendered on your frontend project. We have added support for such contents so you can blend it with the rest of section and define where in the page this content should display in between other sections. To add a local section to your page you just need to add a section object to your payload with type
localand a name of your choice so you can then match it to the right content to render when you are to render the page to your visitor.Static: Static sections are supported out of the box. A static section is a very simple piece of content that provides a basic object storage for the frontend developer. This section can be used to store simple html, medias, DEPRECATED: images in base64 format (do not abuse it :-), or even JS/CSS code if you need to. This section is called static because from a server's perspective the content returned by this section is directly loaded from the Database with no processing, yet you can, as a frontend developer provide very dynamic end results by relying on external APIs at the javascript level (i.e facebook plugins, api request on frontend level etc...). You are just limited by your imagination here.
Dynamic: A dynamic section type is a bit more interesting as the content of such sections will be loaded dynamically server side. A dynamic section type will be declared by a backend third party and it will be called each time this section is requested for rendering.
Configurable: A configurable section is similar to a dynamic one as both have dynamic contents. The difference here is that a configurable section has options that the page editor can choose from. These options are stored in sections and provided to the third party server for rendering so you don't have to worry about that.
Accesses
Accesses to section types varies between:
Public is obviously public to anyone to use. So a public section type can be used by any user from any project. A section will be always declared private. However, only admins of sections can make a section type public. So you should ask them for that, they will review it and take action.
Private section type is only accessible by the project who declared the section type using his project_id and private key as mentioned in the
prerequisitesabove. The project id and private key will be used to make sure that this private section type will only be accessible by the declarer’s project.Public scoped is a public section type that needs authorization to be used. It is accessible to anyone who is authorized to see it. So the project owner will need to pass authorization fields when rendering a public scoped section type in order to be granted the access for it. The authorization fields are per application level. So it only needs to be sent once (the first time). Then the application gains access if the authorization fields are valid.
Returns the list of section types the project owns
GET Section Types
GET /api/v1/project/649abd5184307f02e12b0677/section-types
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEVXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmQ1MTg0MzA3ZjAyZTEyYjA2NzdqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACBlZTFkYzAzN2IyMzg0OWJjYmYzMjlmYjAwZmFjMmNkY20AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAwoZz_IgBYgABUYA.W1aHakrR1i342dJK-RVgenT6CvD9AP1SrRbSt5MzKzQ
origin: http://812d8458-3220-48a8-8dc7-314a1f6e9a8d.com
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-GcsGONmXwEMAA-fD
access-control-allow-origin: http://812d8458-3220-48a8-8dc7-314a1f6e9a8d.com
{
"data": [
{
"type": "static",
"name": "wysiwyg",
"multiple": false,
"id": "649abd48223160f5dd25ce93",
"fields": null,
"dynamic_options": false,
"application_id": null,
"application": "sections",
"access": "public"
},
{
"type": "dynamic",
"requirements": [
"private_key",
"project_id"
],
"query_string_keys": null,
"name": "649abd4a84307f02e14cc588:top_articles",
"multiple": false,
"id": "649abd4b223160f5dd25cebd",
"fields": [],
"dynamic_options": false,
"application_id": "649abd4a84307f02e14cc588",
"application": "649abd4a84307f02e14cc588",
"app_status": "disbaled",
"access": "public_scoped"
},
{
"type": "configurable",
"requirements": [
"private_key",
"project_id"
],
"query_string_keys": null,
"name": "649abd4a84307f02e14cc588:selective_articles",
"multiple": true,
"id": "649abd4b223160f5dd25cebf",
"fields": [
{
"type": "integer",
"name": "articles_ids",
"key": "articles_ids"
}
],
"dynamic_options": true,
"application_id": "649abd4a84307f02e14cc588",
"application": "649abd4a84307f02e14cc588",
"app_status": "disbaled",
"access": "public_scoped"
}
]
}
Load all the section types the project has access to. This can be custom static section types, private section types or public ones exposed by other backend third party developers. For section types with public scoped access you can know their status and required fields in this call also the application id to which they belong. This is helpful for updating your security fields for the considered application.
Request
GET api/v1/project/{project_id}/section-types
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| project_id | Your project id in Sections | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | List of section types resource | Section_Type |
| 401 | Error Resource | Error |
Creates a static section type
Create Static ST
POST /api/v1/project/649abd5384307f02e1e60d28/section-types/section_name_ff79e480-b48d-424e-a6e2-a50706feea05
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEVXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmQ1Mzg0MzA3ZjAyZTFlNjBkMjhqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA2ZTA0Y2RjOGU4NzM0Y2M0YTBjZjA3YjUwYTdjY2QyYm0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAAo9z_IgBYgABUYA.rdUw9JRy5d7Yoiz_hexKLNDZBUwoXIQgyp8pUMmUJLU
origin: http://ffd71493-6995-4aea-bfed-ddb7fa4ed4a8.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"fields": [
{
"type": "image",
"name": "profile"
},
{
"type": "image",
"name": "profile1"
}
]
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-GkjnmjjTE2sABAVB
access-control-allow-origin: http://ffd71493-6995-4aea-bfed-ddb7fa4ed4a8.com
{
"type": "static",
"name": "section_name_ff79e480-b48d-424e-a6e2-a50706feea05",
"multiple": false,
"id": "649abd5384307f02e1e60d29",
"fields": [
{
"type": "image",
"name": "profile"
},
{
"type": "image",
"name": "profile1"
}
],
"dynamic_options": false,
"application_id": null,
"application": "sections",
"access": "private"
}
Declares a PRIVATE static section type for your project. Private sections are exclusive to only one project so these will only be visible by you.
Request
POST api/v1/project/{project_id}/section-types/{section_name}
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| project_id | Your project id in Sections | query_string | string | true | ||
| section_name | Section name | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | section type resource | Section_Type |
| 400 | Error Resource | Error |
| 401 | Error Resource | Error |
| 402 | Error when you reach your package limitation | Error |
Update the authorization fields for the considered app on your project
Upsert authorization fields for an application
PUT /api/v1/project/649abd5284307f02e12b775e/authorization_fields/123456
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEVXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmQ1Mjg0MzA3ZjAyZTEyYjc3NWVqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACAyYjI5ZTFhZjk2Mjk0MWViYjNlNzJiODQxODMzMWY5MG0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYArIlz_IgBYgABUYA.xEx9hvPycht6X6ZImUgJ1TDZGww0O2dzeWGLbjpfJbg
origin: http://b8483050-64d6-4e0a-ad52-826272d6a2b4.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"authorization_fields": {
"project_id": 38,
"private_key": "private_key_hashed"
}
}
Response
404
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-GfeCw5aZvqcABAKh
access-control-allow-origin: http://b8483050-64d6-4e0a-ad52-826272d6a2b4.com
{
"options": {},
"message": "The app does not exist"
}
It verifies the authorization fields provided.
If the fields are valid then the project's configured fields will be updated to include this app's credentials.
These credentials will be used to render any public_scoped section decalred by the third party app.
In case the credentials become invalid their status will be updated and it will need an update from the user.
This call will let you retrieve the application id for any public_scoped section.
If you wish to unauthorize a particular app, you should update your project with the following payload:
{
"configured_fields": {
{replace_with_app_id}: {
"app_status": "disabled"
}
}
}
You can add several app_ids if you wish to unauthorize multiple apps at the same time.
Request
PUT api/v1/project/{project_id}/authorization_fields/{application_id}
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| project_id | Your project id in Sections | query_string | string | true | ||
| application_id | The application's id in Sections | query_string | string | true | ||
| authorization_fields | Authorization fields used to authenticate your request to third party services (only for public scoped section types) | body | map | true | {authorization_fields: {username: 'You', password: 'are awsome'} } |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Project resource | Project |
| 410 | Error Resource | Error |
Renders the requested section's data
Render an existing ST
POST /api/v1/project/649abd5084307f02e18f825b/section/render
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEVXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmQ1MDg0MzA3ZjAyZTE4ZjgyNWJqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACBhMDIwMTQyODI1ZmY0MGFkOGIyZThmNDc5NWRlYmI2N20AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYATYNz_IgBYgABUYA.VTIBU0JnayTONo4gQ6KxNajWflqNw_Eh5ZAUqzTqIuI
origin: http://9e151bdb-dfe3-45c7-875a-314e175f37f5.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"section": {
"weight": 1,
"name": "section_name_b14ecc60-4573-4d00-ae82-4b4bcc41504a"
}
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-GbI6SAdOUH4AA-dj
access-control-allow-origin: http://9e151bdb-dfe3-45c7-875a-314e175f37f5.com
{
"weight": 1,
"type": "static",
"settings": {},
"render_data": "",
"region": {},
"name": "section_name_b14ecc60-4573-4d00-ae82-4b4bcc41504a",
"linked_to": "",
"id": "649abd5184307f02e12b0676",
"error": null
}
Renders the section's data for a preview. When rendering a public scoped section type and the request returns an unauthorized request error (status code 401). The section's status will be updated to invalid. Then it will need the user's intervention to update his credentials for this section's application using this endpoint so the status gets adjusted again.
Request
POST api/v1/project/{project_id}/section/render
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| project_id | Your project id in Sections | query_string | string | true | ||
| query_string | Query Strings | body | map | false | {id: 1} | |
| section | A map containing the section name and its order (weight) in the page | body | map | true | {section: {name: '6038e54de3ba240007b07913:categories_articles', weight: '1'} } |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | section type resource | Section_Type |
| 400 | Error Resource | Error |
| 401 | Error Resource | Error |
Gets a configurable section type's options
Returning the options of a configurable section type to Sections
GET /api/v1/project/649abd4a84307f02e14cc587/section/649abd4a84307f02e14cc588%3Aselective_articles/options
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEVXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmQ0YTg0MzA3ZjAyZTE0Y2M1ODdqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA1NTdhOTc2Y2RmNmU0YWY5ODMyMmIzMjAyZWI1MWRjZG0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYA4mlz_IgBYgABUYA.J1Q1Jfav2ZuIjp3ggfMm7IE9I43NN0XtbRHvBP2i71E
origin: http://13732903-b00d-419c-9d4a-b12aec988488.com
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-GFB0bj7N-8MAA6_C
access-control-allow-origin: http://13732903-b00d-419c-9d4a-b12aec988488.com
[
{
"option_values": [
{
"title": "Article 1",
"id": 1
},
{
"title": "Article 2",
"id": 2
}
],
"field": "article_ids"
}
]
Gets a configurable section type's options from the third party application. This is used so the user can choose the options he wants in order to render the configurable section type customized to his needs.
Request
GET api/v1/project/{project_id}/section/{section_name}/options
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| project_id | Your project id in Sections | query_string | string | true | ||
| section_name | Section name | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Options resource | Options |
| 400 | Error Resource | Error |
| 404 | Error Resource | Error |
Deletes a static section type
Delete Static ST
DELETE /api/v1/project/649abd4e84307f02e149421f/section-types/section_name_89e521d7-0287-4131-a4ef-d7717df1abdc
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEVXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmQ0ZTg0MzA3ZjAyZTE0OTQyMWZqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA2MWY0YWNlMmEwMDc0YjQ4OWNmMDc3NjcyMGU4YzY0MG0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAJnxz_IgBYgABUYA.CHi0i8Tvbjf2-AsIZIwX9AQF1CPCdnUTf4eQD4PaT_s
origin: http://ec67eb3f-f7fe-4a77-8f49-d2d9c4502b4c.com
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-GTqAJ6D73noAA9yD
access-control-allow-origin: http://ec67eb3f-f7fe-4a77-8f49-d2d9c4502b4c.com
{
"message": "Static Section was deleted successfully."
}
Deletes a static section type
Request
DELETE api/v1/project/{project_id}/section-types/{section_name}
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| project_id | Your project id in Sections | query_string | string | true | ||
| section_name | Section name | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | message resource | Message |
| 404 | Error Resource | Error |
4. Packages and API limits
To ensure a faire usage from all users and provide a stable quality of service we have two layers of limitations, the first one is based on the resources your project can use, the bigger the package the more resources you are allowed to use (i.e number of pages, number of static sections types etc...). Once you reach a limit, any tentative to cross this limit will return an error with code 402. The only way for you to overcome this is to free up some resources or to upgrade your package.
Then we also are capping the number of requests you can issue on a project, here again the package you are on will define your cap. The bigger the package the more API requests you will be authorized to submit. If you reach your limit, any further requests will error with code 429. These limits gets reset per time cycle, you can either wait for the cycle to reset your limit or you can upgrade your package to overcome this limit.
Read below to retrieve your project package with the details of the limits applying to it
Gets the current package of the project
GET a package by name and active package/
GET /api/v1/project/649abe0984307f02e15417e3/active_package
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEdXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmUwOTg0MzA3ZjAyZTE1NDE3ZTNqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA5MjY2MDRlNjQwNDg0YWQ2ODQ5NzVkYmRmYWNjNTllOG0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAbVd2_IgBYgABUYA.Y6-K8QkF9L5fhFxDuEDReynen5wgPTrE8LyO_wrt5qU
origin: http://bf00332b-4c20-47b8-8b10-1dda015628fa.com
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-RNKfQZ4Q-7IAA8hi
access-control-allow-origin: http://bf00332b-4c20-47b8-8b10-1dda015628fa.com
{
"type": "public",
"rank": 0,
"quota": -1,
"price": 0,
"name": "free",
"locked": false,
"limits": [
{
"value": 0,
"name": "query_string_support"
},
{
"value": 2,
"name": "number_of_pages"
},
{
"value": 1,
"name": "variation_per_page"
},
{
"value": 5,
"name": "static_sections"
},
{
"value": 5,
"name": "sections_total"
},
{
"value": 10,
"name": "hosted_files"
},
{
"value": 500000,
"name": "size_per_file"
},
{
"value": 10,
"name": "api_limit_sec"
},
{
"value": 100,
"name": "api_limit_minute"
},
{
"value": -1,
"name": "api_limit_hour"
},
{
"value": 500,
"name": "api_limit_day"
},
{
"value": 0,
"name": "dynamic_section_types_support"
},
{
"value": 2,
"name": "users"
},
{
"value": 2,
"name": "domains"
}
],
"label": "Free",
"id": "649abd4884307f02e1453d85"
}
This call will return the package name and associated limits for your project
Request
GET /api/v1/project/{project_id}/active_package
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| token | Sections Token | header | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Package Resource | Package |
Get available packages
GET all public packages
GET /api/v1/project/649abe0a84307f02e10f8a49/packages
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEdXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmUwYTg0MzA3ZjAyZTEwZjhhNDlqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA3MTMxMjEwYTA3NjM0MGE3YmU3MWRiNzUzMjk3MWUwYW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAbVt2_IgBYgABUYA.hG22kB5gakr4d9hW_LNLPkNlGl8P1c22sdvb7zu2dUA
origin: http://64aa4220-57e3-449a-b3c0-d052e831a617.com
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-RPyYONaKaKMAA8ii
access-control-allow-origin: http://64aa4220-57e3-449a-b3c0-d052e831a617.com
{
"total": 5,
"data": [
{
"type": "public",
"rank": 2,
"quota": 2,
"price": 14900,
"name": "corporate",
"locked": false,
"limits": [
{
"value": -1,
"unit_price": 150,
"name": "number_of_pages",
"included": 10
},
{
"value": -1,
"name": "query_string_support"
},
{
"value": 5,
"name": "variation_per_page"
},
{
"value": 20,
"name": "static_sections"
},
{
"value": 15,
"name": "sections_total"
},
{
"value": 300,
"name": "hosted_files"
},
{
"value": 2000000,
"name": "size_per_file"
},
{
"value": -1,
"name": "api_limit_sec"
},
{
"value": -1,
"name": "api_limit_minute"
},
{
"value": 3000,
"name": "api_limit_hour"
},
{
"value": 20000,
"name": "api_limit_day"
},
{
"value": -1,
"name": "dynamic_section_types_support"
},
{
"value": 5,
"name": "users"
},
{
"value": -1,
"unit_price": 1000,
"name": "domains",
"included": 3
}
],
"label": "Corporate",
"id": "649abd4884307f02e1453d87"
},
{
"type": "public",
"rank": 0,
"quota": -1,
"price": 0,
"name": "free",
"locked": false,
"limits": [
{
"value": 0,
"name": "query_string_support"
},
{
"value": 2,
"name": "number_of_pages"
},
{
"value": 1,
"name": "variation_per_page"
},
{
"value": 5,
"name": "static_sections"
},
{
"value": 5,
"name": "sections_total"
},
{
"value": 10,
"name": "hosted_files"
},
{
"value": 500000,
"name": "size_per_file"
},
{
"value": 10,
"name": "api_limit_sec"
},
{
"value": 100,
"name": "api_limit_minute"
},
{
"value": -1,
"name": "api_limit_hour"
},
{
"value": 500,
"name": "api_limit_day"
},
{
"value": 0,
"name": "dynamic_section_types_support"
},
{
"value": 2,
"name": "users"
},
{
"value": 2,
"name": "domains"
}
],
"label": "Free",
"id": "649abd4884307f02e1453d85"
},
{
"type": "public",
"rank": 3,
"quota": -1,
"price": 1999,
"name": "package_by_id",
"locked": false,
"limits": [
{
"value": -1,
"name": "query_string_support"
},
{
"value": 2,
"name": "number_of_pages"
},
{
"value": 1,
"name": "variation_per_page"
},
{
"value": 10,
"name": "static_sections"
},
{
"value": 5,
"name": "sections_total"
},
{
"value": 10,
"name": "hosted_files"
},
{
"value": 500000,
"name": "size_per_file"
},
{
"value": 10,
"name": "api_limit_sec"
},
{
"value": 100,
"name": "api_limit_minute"
},
{
"value": 100,
"name": "api_limit_hour"
},
{
"value": 500,
"name": "api_limit_day"
},
{
"value": -1,
"name": "dynamic_section_types_support"
},
{
"value": 2,
"name": "users"
},
{
"value": 5,
"name": "domains"
}
],
"label": "Free",
"id": "649abe0884307f02e1e8065c"
},
{
"type": "public",
"rank": 3,
"quota": -1,
"price": 1999,
"name": "premium",
"locked": false,
"limits": [
{
"value": -1,
"name": "query_string_support"
},
{
"value": 20,
"name": "number_of_pages"
},
{
"value": 1,
"name": "variation_per_page"
},
{
"value": 10,
"name": "static_sections"
},
{
"value": 5,
"name": "sections_total"
},
{
"value": 7,
"name": "hosted_files"
},
{
"value": 500000,
"name": "size_per_file"
},
{
"value": 10,
"name": "api_limit_sec"
},
{
"value": -1,
"name": "api_limit_hour"
},
{
"value": 100,
"name": "api_limit_minute"
},
{
"value": 500,
"name": "api_limit_day"
},
{
"value": -1,
"name": "dynamic_section_types_support"
},
{
"value": 2,
"name": "users"
},
{
"value": 5,
"name": "domains"
}
],
"label": "premium",
"id": "649abe0984307f02e15417e2"
},
{
"type": "public",
"rank": 1,
"quota": -1,
"price": 2900,
"name": "solo",
"locked": false,
"limits": [
{
"value": 0,
"name": "query_string_support"
},
{
"value": 5,
"name": "number_of_pages"
},
{
"value": 2,
"name": "variation_per_page"
},
{
"value": 10,
"name": "static_sections"
},
{
"value": 10,
"name": "sections_total"
},
{
"value": 100,
"name": "hosted_files"
},
{
"value": 1000000,
"name": "size_per_file"
},
{
"value": -1,
"name": "api_limit_sec"
},
{
"value": -1,
"name": "api_limit_minute"
},
{
"value": 500,
"name": "api_limit_hour"
},
{
"value": 1000,
"name": "api_limit_day"
},
{
"value": 0,
"name": "dynamic_section_types_support"
},
{
"value": 2,
"name": "users"
},
{
"value": 1,
"name": "domains"
}
],
"label": "Standard",
"id": "649abd4884307f02e1453d86"
}
]
}
This call will list all the public and private packages with their attached limits that your project can subscribe to. If you have specific needs requiring the customization of certains limits, contact us to build with you a custom private package. Note that locked package won't be returned here unless you it is the package you are already subscribed to. If you update your project from a locked package to another one, you won't be able to come back to the locked package.
Request
GET /api/v1/project/{project_id}/packages
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| token | Sections Token | header | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | List of package resource | Package |
5. User Management
This part will guide on how to manage your account on Sections.
Register through the API
Register user and project
POST /api/v1/register
origin: http://clientapp.com:3001
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEdXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmRiMjg0MzA3ZjAyZTFkOTZkODRqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA4MmQ3N2UxMjMyNDI0NWEwOTE1NTk2NGU4MDE5OTA4ZW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAOwJ1_IgBYgABUYA.3LxzNMgeNk0Gt-gUrvTU0jUbICtLK92lnqnTOMx1ZBo
content-type: multipart/mixed; boundary=plug_conn_test
{
"user": {
"terms_conditions": true,
"password": "password",
"full_name": "Fullname",
"email": "success@gmail.com"
},
"project": {
"title": "Your Project Title",
"project_url": [
"your.url.com"
],
"login_redirect_url": "https://your.url.com"
}
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-MHIfDqKOMZQABBIB
access-control-allow-origin: http://clientapp.com:3001
{
"data": {
"user": {
"user_id": "123userid123",
"saas_project_id": [
{
"title": "Your Project Title",
"saas_project_id": "649abdb284307f02e1d96d85",
"role": "admin"
}
],
"last_login": 1687862707,
"full_name": "Someone",
"email": "someoned8e6f7a23e4d43c58887fdda7f39e99e@eweev.com"
},
"token": {
"token": "this is a token"
},
"project": {
"updated_at": 1687862706,
"type": "private",
"title": "Your Project Title",
"reason": null,
"project_url": [
"your.url.com"
],
"private_key": "$2b$12$DqqM1MVA8lLYM.CYxfoJAOulLkMLpnHIU2onb165owC1XZJF32JWq",
"package": "free",
"login_redirect_url": "https://your.url.com",
"limitation_status": "active",
"last_req_date": null,
"inserted_at": "2023-06-27",
"id": "649abdb284307f02e1d96d85",
"files_counter": 0,
"configured_fields": {},
"billing_status": "upgrade_lock",
"active": true,
"__meta__": {
"state": "built",
"source": "project",
"schema": "Elixir.Sections.Section.Project",
"prefix": null,
"context": null
}
}
}
}
API Route to be able to register a new user, and create this user's new project.
We now support the ability to include multiple project URLs used to pass CORS, by passing
a list of valid URLS as the value of project_key
Request
POST api/v1/register
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project | Project Model. | body | map | true | {'active' => true,'configured_fields' => {'blogs' => {'private_key' => 'xxxxxx','project_id' => 1}},'files_counter' => 0,'id' => '601bf1221907a50007ba3f81','login_redirect_url' => 'https://your.project.url.com/redirect_login/admin','package' => 'free','private_key' => 'xxxxxx','project_url' => ['https://your.project.url.com'],'reason' => nil,'type' => 'private'} | |
| user | User Model. | body | map | true | {email: 'your_new_email@gmail.com', password: 'new_pass', current_pass: 'current_pass'} } |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | User resource | User |
| 410 | Error Resource | Error |
Get the pending invitations to a project.
Invite user to project success - user exists
GET /api/v1/project/649abdb884307f02e1ed0599/pending_invitations
origin: http://08e26d90-a18b-4219-aec3-db9b883b2e5a.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAFYWRtaW5tAAAAD3NhYXNfcHJvamVjdF9pZG0AAAAYNjQ5YWJkYjg4NDMwN2YwMmUxZWQwNTk5am0AAAAGc3RhdHVzbQAAAAh2ZXJpZmllZG0AAAAHdXNlcl9pZG0AAAAgZDMxZDQ5NGYwNmNiNDk5OTliMzg0YzU3OWVhZDQ2NTVtAAAABnN0YXR1c20AAAAHc3VjY2Vzc24GAOEadfyIAWIAAVGA.573IBv6ShvnCj4h_O_u7wtOS0k0E4QuPVUSPql0zPis
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-MfbO6FPziPUABBOh
access-control-allow-origin: http://08e26d90-a18b-4219-aec3-db9b883b2e5a.com
{
"users": [
{
"role": "webmaster",
"invited_at": 1687862713,
"email": "email@eweev.com"
}
],
"total": 1
}
Used to fetch pending invitation to (existing or non existing) user emails to join your project with a specific role.
Request
GET api/v1/project/:project_id/pending_invitations
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Pending Invitation Resource | Pending_Invitation |
| 401 | Error Resource | Error |
Get your user information.
get user based on token
GET /api/v1/project/649abdb784307f02e10b48c9/user
origin: http://517c6c7c-e775-42bc-9dbc-91081b564e09.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAJd2VibWFzdGVybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY0OWFiZGI3ODQzMDdmMDJlMTBiNDhjOWptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGU3MDlkNGM0NTViYTRjYTM4YjU1NDBiZDBlMDU4MDMzbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBjFnX8iAFiAAFRgA.pZh-hOVXprhrCEDHHfVtn-cLTK0x6HwtrTidZ_wJI0M
{
"aspect": "body_params"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-MZzuPfbE2pcAA-jD
access-control-allow-origin: http://517c6c7c-e775-42bc-9dbc-91081b564e09.com
{
"token": null,
"status": null,
"roles": null,
"projects": [
{
"saas_project_id": "649abdb784307f02e10b48c9",
"role": "admin"
}
],
"inserted_at": null,
"id": "1",
"full_name": "Full Name",
"email": "email@eweev.com"
}
Used to get your own user information based on the token.
Request
GET api/v1/project/:project_id/user
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| origin | Request Origin | header | string | true | https://your.project.url.com | |
| token | Sections Token | header | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | User resource | User |
| 401 | Error Resource | Error |
Verify your Sections account
Verify user
POST /api/v1/verify_user
origin: http://clientapp.com:3001
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEdXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmRiNjg0MzA3ZjAyZTFlYmJlMzNqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACBlZWJlZjNkODAwNGQ0NjNhODc0NDBjMzNmZTg5NzE2MG0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAJBN1_IgBYgABUYA.RcopELh-6TNA8ooY3OXu2M3hR6lMGXIvKNr5rus0Cl0
content-type: multipart/mixed; boundary=plug_conn_test
{
"token": "this is the token"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-MXP-8Hd0AEoABBMB
access-control-allow-origin: http://clientapp.com:3001
{
"message": "Your email has been successfully verified."
}
Used to verify your Sections account.
You are expected to use the token received in the verification email as the token authorization header.
Request
POST api/v1/verify_user
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| origin | Request Origin | header | string | true | https://your.project.url.com |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Message resource | Message |
| 410 | Error Resource | Error |
Login through the API
login
POST /login
origin: http://clientapp.com:3001
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEdXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmRiMTg0MzA3ZjAyZTFiMTkwZTJqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA4N2FkMDE2MTEwNmI0NGJlYmUxYTQyNDdiYzI1NTU4OG0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAS_90_IgBYgABUYA.T4yFQMiQDA3v6Z2vVMYr6fVMRlTgJ_FcZQ8D74zugDM
content-type: multipart/mixed; boundary=plug_conn_test
{
"password": "password",
"email": "success@gmail.com"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-MEX-VDUdONMAA-fj
x-frame-options: SAMEORIGIN
x-xss-protection: 1; mode=block
x-content-type-options: nosniff
x-download-options: noopen
x-permitted-cross-domain-policies: none
cross-origin-window-policy: deny
{
"token": {
"token": "this is a token"
},
"status": null,
"roles": null,
"projects": [
{
"title": null,
"saas_project_id": "649abdb184307f02e1b190e2",
"role": "webmaster"
}
],
"inserted_at": null,
"id": "123userid123",
"full_name": "Someone",
"email": "someone8afb4db12a4d438b8849e48ce6b01ac3@eweev.com"
}
API Route to be able to login and retrieve a user token, used for authorization.
The project_id query parameter, alongside the project URL as the origin header, are used to be able to pass CORS.
You can also use the encoded version of the project private key to bypass CORS, and act as the project administrator.
Request
POST api/v1/login?project_id={PROJECT_ID}
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| origin | Request Origin | header | string | true | https://your.project.url.com |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | User resource | User |
| 410 | Error Resource | Error |
Updates User
Update User
PUT /api/v1/project/649abdd684307f02e11ee2a7/user
origin: http://2db3b16f-c017-4efe-bfa5-99629f5a48da.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEdXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmRkNjg0MzA3ZjAyZTExZWUyYTdqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACBmNzkxYjA0ZTk1MmU0NjQ5YTU4NTg3MzUxM2ZjNDg3Ym0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYADpF1_IgBYgABUYA.nK0Z6JCz-1fAUbyZBnaXK1MGxSLbRaIxbawBs8WnpKs
content-type: multipart/mixed; boundary=plug_conn_test
{
"password": "new_password",
"full_name": "Your updated name",
"email": "new_email@eweev.com",
"current_password": "your_current_pass",
"confirm_password": "new_password"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-OOytxjZNbY8ABByh
access-control-allow-origin: http://2db3b16f-c017-4efe-bfa5-99629f5a48da.com
{
"token": null,
"status": "pending",
"roles": null,
"projects": null,
"inserted_at": null,
"id": "f791b04e952e4649a585873513fc487b",
"full_name": "Your updated name",
"email": "new_email@eweev.com"
}
This call updates the user. Be careful when updating your email or password you need to supply you current password to authenticate your call under the field current_password.
Request
PUT api/v1/project/{project_id}/user
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| token | Sections Token | header | string | true | ||
| user | User Model. | body | map | true | {email: 'your_new_email@gmail.com', password: 'new_pass', current_pass: 'current_pass'} } |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | section type resource | User |
| 400 | section type resource | Error |
| 410 | Error Resource | Error |
Add a User
Add a user to a project
PUT /api/v1/project/649abdd484307f02e15f596a/add_user
origin: http://3fccbc33-82e8-4b15-820c-deea0edeaf5b.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEdXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmRkNDg0MzA3ZjAyZTE1ZjU5NmFqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACBlZTgzZWI3ODcyZTI0ZDZjYTIzNzY3NGEwMWE3MThjM20AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYA5Ih1_IgBYgABUYA.I0padgls91_gCi8G0t3rhhoZ5ph-slqSR1icnpJrEEI
content-type: multipart/mixed; boundary=plug_conn_test
{
"saas_project_id": "649abdd484307f02e15f596a",
"role": "User",
"email": "USER_EMAIL@gmail.com"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-OHAMJ_6Yj3MABBvh
access-control-allow-origin: http://3fccbc33-82e8-4b15-820c-deea0edeaf5b.com
{
"token": null,
"status": null,
"roles": null,
"projects": [
{
"saas_project_id": "649abdd484307f02e15f596a",
"role": "User",
"accepted_on": 1687862741
}
],
"inserted_at": null,
"id": "729128cd-42a5-485c-839f-e44622174dcb",
"full_name": null,
"email": null
}
This call adds the user, of the given email, to a project you are an admin on.
Request
PUT api/v1/project/{project_id}/add_user
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| token | Sections Token | header | string | true | ||
| user | User Model. | body | map | true | [123,10,32,32,32,32,32,32,34,115,97,97,115,95,112,114,111,106,101,99,116,95,105,100,34,58,32,34,54,48,100,97,101,49,97,49,48,97,57,57,56,54,50,99,50,97,55,48,97,98,49,49,34,44,10,32,32,32,32,32,32,34,114,111,108,101,34,58,32,34,85,115,101,114,34,44,10,32,32,32,32,32,32,34,101,109,97,105,108,34,58,32,34,97,46,115,97,114,107,105,115,43,98,108,111,103,49,48,48,64,101,119,101,101,118,46,99,111,109,34,10,32,32,32,32,125] |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | section type resource | User |
| 400 | section type resource | Error |
| 401 | Error Resource | Error |
| 404 | section type resource | Error |
Invite a user to join your project
Invite user to project success - user exists
POST /api/v1/project/649abdb884307f02e1ed0599/invite_user
origin: http://08e26d90-a18b-4219-aec3-db9b883b2e5a.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAFYWRtaW5tAAAAD3NhYXNfcHJvamVjdF9pZG0AAAAYNjQ5YWJkYjg4NDMwN2YwMmUxZWQwNTk5am0AAAAGc3RhdHVzbQAAAAh2ZXJpZmllZG0AAAAHdXNlcl9pZG0AAAAgZDMxZDQ5NGYwNmNiNDk5OTliMzg0YzU3OWVhZDQ2NTVtAAAABnN0YXR1c20AAAAHc3VjY2Vzc24GAOEadfyIAWIAAVGA.573IBv6ShvnCj4h_O_u7wtOS0k0E4QuPVUSPql0zPis
content-type: multipart/mixed; boundary=plug_conn_test
{
"invitation_user_email": [
"email@eweev.com"
],
"invitation_role": "webmaster"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-MeGBz57ziPUABBOB
access-control-allow-origin: http://08e26d90-a18b-4219-aec3-db9b883b2e5a.com
{
"invited": [
"email@eweev.com"
],
"invalid_format": [],
"failed_to_send": [],
"demotion": []
}
Used to send an invitation to (existing or non existing) user emails to join your project with a specific role.
Request
POST api/v1/project/:project_id/invite_user
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| invitation_role | The role to invite the users as | body | string | true | one of:webmaster,admin | |
| invitation_emails | List of emails to invite to the project | body | array | true | ['email1@gmail.com','email2@gmail.com'] |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Invitation Resource | Invitation |
| 401 | Error Resource | Error |
Accept an invitation to join a project.
Accept invitation to project success - user exists
POST /api/v1/invitation/accept_invitation
origin: http://d23aac2f-97b5-4ecc-b4d3-d1fa6a6fcbf6.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEdXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmRiYTg0MzA3ZjAyZTE2YjgxM2ZqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA4ODAwOWQ3NDBhZDM0ODkwOTE0YWU2YTE4M2E5ZGQ4OW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAViB1_IgBYgABUYA.iP3GvnbtaskH70KKKmLivpL1qRm1NjIg1RY30mG45AI
content-type: multipart/mixed; boundary=plug_conn_test
{
"invitation_token": "SFMyNTY.g2gDdAAAAANtAAAACnByb2plY3RfaWRtAAAAGDY0OWFiZGJhODQzMDdmMDJlMTZiODEzZm0AAAAEcm9sZW0AAAAJd2VibWFzdGVybQAAAAp1c2VyX2VtYWlsbQAAABBlbWFpbDFAZW1haWwuY29tbgYAfiF1_IgBYgABUYA.tsoytvwVpoFknTMliBIOD7IwyrpTDTeMTyShlS-uFhw"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-MkZY7SedOsYABBQB
{
"token": null,
"status": null,
"roles": null,
"projects": [
{
"title": null,
"saas_project_id": "649abdba84307f02e16b813f",
"role": "webmaster"
}
],
"inserted_at": null,
"id": "7c3916521cfe43479d69791ffaaf75a0",
"full_name": "Full name",
"email": "email1@email.com"
}
Used to accept an invitation to join a project with a specific role.
You are expected to add the token received in the email as the token authorization header.
Request
POST /api/v1/invitation
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | User Resource | User |
| 401 | Error Resource | Error |
Cancel an invitation
Accept invitation to project failure - invitation cancelled
DELETE /api/v1/project/649abdc184307f02e17ddf42/cancel_invitation
origin: http://87acbe81-35f0-4cdb-8123-b9fceeba5312.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAFYWRtaW5tAAAAD3NhYXNfcHJvamVjdF9pZG0AAAAYNjQ5YWJkYzE4NDMwN2YwMmUxN2RkZjQyam0AAAAGc3RhdHVzbQAAAAh2ZXJpZmllZG0AAAAHdXNlcl9pZG0AAAAgMmRhMGNlMDZiYWUwNGU2N2FiZGI2YWEwODBkMDg2YjJtAAAABnN0YXR1c20AAAAHc3VjY2Vzc24GAKNAdfyIAWIAAVGA.h1UTpGmlGhoIlgu0QTM3qQk8T-EymDT8f6irfaksOsE
content-type: multipart/mixed; boundary=plug_conn_test
{
"invitation_user_email": "email1@email.com"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-NDcQcbFxDcEABBYB
access-control-allow-origin: http://87acbe81-35f0-4cdb-8123-b9fceeba5312.com
{
"message": "Invitation cancelled successfuly"
}
Used to cancel invitations sent to specific emails.
Request
DELETE api/v1/project/:project_id/cancel_invitation
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| invitation_email | Email to cancel invitation to the project | body | string | true | 'email1@gmail.com','email2@gmail.com' |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Message Resource | Message |
| 401 | Error Resource | Error |
6. Medias
This part is dedicated to give you a clear idea on how to manage your medias. A media is an entity that holds a file that can be used across multiple sections. We can create a media using a base64 file. You are limited to the number of medias and the size of each media file based on your subscription.
Creates a media
Create a page with valid section using medias ids then keep sync
POST /api/v1/project/649abd5084307f02e18f825d/media
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEVXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmQ1MDg0MzA3ZjAyZTE4ZjgyNWRqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACAxN2I3NThjMDEzZjQ0MjA0YjcwZTc1YWY4OTcwNjg1M20AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAyINz_IgBYgABUYA.SbrQ_KAcFjXOfcdDW4cLfo-cX7uPTWHZSAPQ86f9udg
origin: http://62ce9e26-b47d-4191-9989-3a17d6512c48.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"type": "image",
"private_status": "public",
"locked_status": "unlocked",
"files": {
"1": {
"file": {
"path": "test/support/toggle.png",
"filename": "blue.svg",
"content_type": "image/svg"
}
}
}
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-GZ2eJ0xU238AA7sC
access-control-allow-origin: http://62ce9e26-b47d-4191-9989-3a17d6512c48.com
{
"type": "image",
"title": null,
"tags": null,
"seo_tag": null,
"private_status": "public",
"number_of_contents": 0,
"namespace": "649abd5084307f02e18f825d",
"meta": {},
"locked_status": "unlocked",
"id": "649abd5584307f02e162b429",
"files": [
{
"url": "https://www.fake-url.com/8aa94e08030b46458efb967562ec91fe",
"type": "image/svg",
"thumbnail_url": "https://www.fake-url.com/35d16e16df1d41a18dedf58e569f2864",
"size": 3949,
"platform_id": "611696250a998650895fdf2f",
"metadata": {
"width": 80,
"height": 80
},
"filename": "fake_filename",
"file_id": "fake_file_id"
}
],
"creation_date": "2023-06-27",
"author": "17b758c013f44204b70e75af89706853"
}
Creates a media with a given file
Request
POST api/v1/project/{project_id}/media
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| id | The media id | query_string | string | true | ||
| section | A map containing the file | body | map | true | {1: {file: 'BASE64_STRING_HERE', base64: true}} |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Media resource | Media |
| 400 | Error Resource | Error |
| 404 | Error Resource | Error |
Renders a media
Create a page with valid section using medias ids then keep sync
GET /api/v1/project/649abd5084307f02e18f825d/media/649abd5584307f02e162b429
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEVXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmQ1MDg0MzA3ZjAyZTE4ZjgyNWRqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACAxN2I3NThjMDEzZjQ0MjA0YjcwZTc1YWY4OTcwNjg1M20AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAyINz_IgBYgABUYA.SbrQ_KAcFjXOfcdDW4cLfo-cX7uPTWHZSAPQ86f9udg
origin: http://62ce9e26-b47d-4191-9989-3a17d6512c48.com
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-GsUwgMhU238AA74i
access-control-allow-origin: http://62ce9e26-b47d-4191-9989-3a17d6512c48.com
{
"type": "image",
"title": null,
"tags": null,
"seo_tag": null,
"private_status": "public",
"number_of_contents": 0,
"namespace": "649abd5084307f02e18f825d",
"meta": {
"content": [],
"author": "deleted_user"
},
"locked_status": "unlocked",
"id": "649abd5584307f02e162b429",
"files": [
{
"url": "https://www.fake-url.com/8aa94e08030b46458efb967562ec91fe",
"type": "image/svg",
"thumbnail_url": "https://www.fake-url.com/35d16e16df1d41a18dedf58e569f2864",
"size": 3949,
"platform_id": "611696250a998650895fdf2f",
"platform": {
"width": 1000,
"updated_at": 1628870181,
"number_of_medias": 0,
"namespace": "sections_app",
"name": "Global Platform",
"inserted_at": 1628870181,
"id": "611696250a998650895fdf2f",
"height": 1000,
"description": "This is the only platform used for sections"
},
"metadata": {
"width": 80,
"height": 80
},
"filename": "fake_filename",
"file_id": "fake_file_id"
}
],
"creation_date": 1687862613,
"author": "17b758c013f44204b70e75af89706853"
}
Renders the media with its details.
Request
GET api/v1/project/{project_id}/media/{id}
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| id | The media id | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Media resource | Media |
| 400 | Error Resource | Error |
| 404 | Error Resource | Error |
Renders all medias for this project.
List medias
POST /api/v1/project/649abd4984307f02e1d2570f/medias
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEVXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmQ0OTg0MzA3ZjAyZTFkMjU3MGZqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACAyNjllZTEwNzUwN2U0ZDZiOTY4OGFhZGEzNmQ0MmRmY20AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAt2dz_IgBYgABUYA.x6RnkUZ00rzzipRRzI77auG3n42js85m-n7GNbQbKGI
origin: http://c0885bde-c368-44cb-b4b3-c9b8ba4424d3.com
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-GTRh6rLgMHoAA9rD
access-control-allow-origin: http://c0885bde-c368-44cb-b4b3-c9b8ba4424d3.com
{
"total": 1,
"result": [
{
"type": "image",
"title": null,
"tags": null,
"seo_tag": null,
"private_status": "public",
"number_of_contents": 0,
"namespace": "649abd4984307f02e1d2570f",
"meta": {},
"locked_status": "unlocked",
"id": "649abd4e84307f02e149421d",
"files": [
{
"url": "https://www.fake-url.com/db8f966c6df44f57923f772f95a4f409",
"type": "image/svg",
"thumbnail_url": "https://www.fake-url.com/b6327c5a33664dcc8b028e3d9864837b",
"size": 3949,
"platform_id": "611696250a998650895fdf2f",
"platform": {
"width": 1000,
"updated_at": 1628870181,
"number_of_medias": 0,
"namespace": "sections_app",
"name": "Global Platform",
"inserted_at": 1628870181,
"id": "611696250a998650895fdf2f",
"height": 1000,
"description": "This is the only platform used for sections"
},
"metadata": {
"width": 80,
"height": 80
},
"filename": "fake_filename",
"file_id": "fake_file_id"
}
],
"creation_date": 1687862606,
"author": "269ee107507e4d6b9688aada36d42dfc"
}
]
}
Renders the medias with their details.
Request
POST api/v1/project/{project_id}/medias
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Array of Media resource | Media |
Updates a media
Create a page with valid section using medias ids then keep sync
PUT /api/v1/project/649abd5084307f02e18f825d/media/649abd5584307f02e162b429
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbGQAA25pbG0AAAAPc2Fhc19wcm9qZWN0X2lkbAAAAAF0AAAAAm0AAAAEcm9sZW0AAAAEVXNlcm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2NDlhYmQ1MDg0MzA3ZjAyZTE4ZjgyNWRqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACAxN2I3NThjMDEzZjQ0MjA0YjcwZTc1YWY4OTcwNjg1M20AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAyINz_IgBYgABUYA.SbrQ_KAcFjXOfcdDW4cLfo-cX7uPTWHZSAPQ86f9udg
origin: http://62ce9e26-b47d-4191-9989-3a17d6512c48.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"type": "image",
"private_status": "public",
"locked_status": "unlocked",
"files": {
"1": {
"file": {
"path": "test/support/toggle.png",
"filename": "blue.svg",
"content_type": "image/svg"
}
}
}
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-G6AgH4NU238ABAYh
access-control-allow-origin: http://62ce9e26-b47d-4191-9989-3a17d6512c48.com
{
"type": "image",
"title": null,
"tags": null,
"seo_tag": null,
"private_status": "public",
"number_of_contents": 0,
"namespace": "649abd5084307f02e18f825d",
"meta": {},
"locked_status": "unlocked",
"id": "649abd5584307f02e162b429",
"files": [
{
"url": "https://www.fake-url.com/76ac840b46df4022ae27d59d9e1e5194",
"type": "image/svg",
"thumbnail_url": "https://www.fake-url.com/e4af339464a04a5ba1b3b51f57f4a73d",
"size": 3949,
"platform_id": "611696250a998650895fdf2f",
"metadata": {
"width": 80,
"height": 80
},
"filename": "fake_filename",
"file_id": "fake_file_id"
}
],
"creation_date": "2023-06-27",
"author": "17b758c013f44204b70e75af89706853"
}
Updates a media with a given file
Request
POST api/v1/project/{project_id}/media/{id}
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| project_id | Your project id in Sections | query_string | string | true | ||
| id | The media id | query_string | string | true | ||
| section | A map containing the file | body | map | true | {1: {file: 'BASE64_STRING_HERE', base64: true}} |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Media resource | Media |
| 400 | Error Resource | Error |
| 404 | Error Resource | Error |
7. Project Management
This part will guide on how to manage your project on Sections.
Update a project
Update project
PUT /api/v1/project/649abd5184307f02e12b067a
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACA1MmU1NWMwNDMyYTU0ZDgxODMxNDc4YTI0ZDk3MWVmNG0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAUodz_IgBYgABUYA.mUkambtOuMzfpV4uHrfgbBcA1Xx5lW5oFAC9gTYChIY
pkey: $2b$12$Szo2Dd88gm9XanfdxDnIHOeBTc1S/dLa5LnKC7RPZPHvqoZTZWaBy
content-type: multipart/mixed; boundary=plug_conn_test
{
"title": "New title 123"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-GfIaJQXzEEoAA7wC
{
"updated_at": 1687862610,
"type": "private",
"title": "New title 123",
"reason": null,
"project_url": [
"http://localhost:3000",
"d839c94a-f76f-4b3e-9aea-bc08abce0538.com"
],
"private_key": "$2b$12$Tcpv/EjUmSK5DTsKo32j5uM2ghMfSBxa2kjKEQ.0NAuxdyevVnR66",
"package": "free",
"login_redirect_url": "http://localhost:3000/redirect-login",
"limitation_status": "active",
"last_req_date": null,
"inserted_at": "2023-06-27",
"id": "649abd5184307f02e12b067a",
"files_counter": 0,
"configured_fields": {},
"billing_status": "upgrade_lock",
"active": true,
"__meta__": {
"state": "built",
"source": "project",
"schema": "Elixir.Sections.Section.Project",
"prefix": null,
"context": null
}
}
Used to update any project field.
Notes:
- For the project_url and login_redirect_url fields, you can specify any of the following patterns for local testing:
- localhost:PORT with HTTP:// or HTTPS://
- Class A,B,C Private addresses with HTTP://
Request
PUT api/v1/project/:project_id/
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| origin | Request Origin | header | string | true | https://your.project.url.com | |
| project | Project Model. | body | map | true | {'active' => true,'configured_fields' => {'blogs' => {'private_key' => 'xxxxxx','project_id' => 1}},'files_counter' => 0,'id' => '601bf1221907a50007ba3f81','login_redirect_url' => 'https://your.project.url.com/redirect_login/admin','package' => 'free','private_key' => 'xxxxxx','project_url' => ['https://your.project.url.com'],'reason' => nil,'type' => 'private'} |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Project Resource | Project |
| 400 | Error Resource | Error |
Reset a Project's private key
Reset project private key
PUT /api/v1/project/649abd5484307f02e156dcb7/reset_key
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACBjYTU2MWRjZjhhNjU0NTAzYTQ3MjQwMTY3NjM0ZWUxZm0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYA7JFz_IgBYgABUYA.l1U96wIscS65fJ6mEsankttk7bPpfOMhq0ZfsW2jeXY
pkey: $2b$12$7dt85FAXz6X2e17z5gx9OOc5R/JtnA4BDuqoCSc84LlQaKVnrHuKC
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-GpH1-vDmNUoAA72i
{
"message": "Your project private key was successfully reset. The old one does not work anymore. Make sure to update the private key to the new one wherever you are using it."
}
Used to reset the private key field of a project.
Request
PUT api/v1/project/:project_id/reset_key
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| origin | Request Origin | header | string | true | https://your.project.url.com |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Project Resource | Project |
| 400 | Error Resource | Error |
Get a project's dahsboard metrics
Get project dashboard
GET /api/v1/project/649abd4a84307f02e14cc589/dashboard
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACA3YzdiMDJkZTdhZTE0MDE0ODZkMDNjZTNjM2UzYzBiN20AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYA52hz_IgBYgABUYA.CjllYOXVLEGER7YOKK8A8nvWTnubll_Zz3Lw4x6rzv0
pkey: $2b$12$Bo.330KC.LQSlq59bMJAWOzrxhUu7JHXNuzFWrpU6R9RqsH6Cbee6
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-GEKEKeJ6xjgAA_wh
{
"package_name": "free",
"package_locked": false,
"max_pages": 2,
"max_media_files": 10,
"max_file_size": 500000,
"current_pages": 0,
"current_medias": 0,
"api_until_reset": 47796551,
"api_limit_use": 500,
"api_current_use": 0
}
Used to retrieve a project's dashboard metrics such as package limitations and current usage.
Request
GET api/v1/project/:project_id/dashboard
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| origin | Request Origin | header | string | true | https://your.project.url.com | |
| project | Project Model. | body | map | true | {'active' => true,'configured_fields' => {'blogs' => {'private_key' => 'xxxxxx','project_id' => 1}},'files_counter' => 0,'id' => '601bf1221907a50007ba3f81','login_redirect_url' => 'https://your.project.url.com/redirect_login/admin','package' => 'free','private_key' => 'xxxxxx','project_url' => ['https://your.project.url.com'],'reason' => nil,'type' => 'private'} |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Dashboard Resource | Dashboard |
| 400 | Error Resource | Error |
8. Sections Admin Only Access
This part wil guide Sections Admins on actions they only can perform.
Get projects
test pagination and filtering of projects GET /api/v1/auth/project pagination limit and start
GET /api/v1/auth/project?start=1&limit=1
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACA4ZmI2ODQxODc2M2Y0ZmM5Yjg1NDVhMzdkODUwZTk3NG0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYApsV1_IgBYgABUYA.PuQGkdSS23qARPvzA3Cf6s_M4OZDXrFcYLIAZAKmurE
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-PC5VD6mvc9IABB8B
access-control-allow-origin: http://clientapp.com:3001
{
"total": 104,
"public_packages": [
{
"value": "Free",
"key": "free"
},
{
"value": "Standard",
"key": "solo"
},
{
"value": "Corporate",
"key": "corporate"
}
],
"data": [
{
"updated_at": 1687862603,
"type": "private",
"title": null,
"reason": null,
"project_url": [
"13732903-b00d-419c-9d4a-b12aec988488.com"
],
"private_packages": [],
"package": "free",
"login_redirect_url": null,
"limitation_status": "active",
"last_request_user": {
"role": null,
"full_name": null,
"email": null
},
"last_req_date": 1687862603,
"inserted_at": 1687862602,
"id": "649abd4a84307f02e14cc587",
"files_counter": 0,
"configured_fields": {
"649abd4a84307f02e14cc588": {
"project_id": 11,
"private_key": "pkey"
}
},
"billing_status": "upgrade_lock",
"active": true,
"__meta__": {
"state": "built",
"source": "project",
"schema": "Elixir.Sections.Section.Project",
"prefix": null,
"context": null
}
}
]
}
Used to retrieve list of projects. Current supported filters are:
earliest_last_req_date: Timestamp of last_req_date as the earliest, ex:
1687862593latest_last_req_date: Timestamp of last_req_date as the latest, ex:
1687862593package: package name that the project subscribed to, ex:
corporateproject_url: project that has this project_url in his list, ex:
https://your.project.url.comid: project id, ex:
628cbb71e537f4000619c0b7full_name: last request user full name, ex:
User Full Nameemail: last request user email, ex: `some_email@gmail.com
Request
POST api/v1/auth/projects
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | List of Project Resource | Project |
| 400 | Error Resource | Error |
Create a new package
create a package and create and existing package
POST /api/v1/auth/package
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACAxMjQ2MmNmMmYwNjg0MDZkYjIxMjBiMWFiOWJkNzhkYm0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYA4mF2_IgBYgABUYA.35c7ovIX_YlxHaw0LIJCQRSBPvlAwmOQTjSrlrMkE6I
origin: http://b1123a6b-15ed-46d9-9e75-d48741b2ec17.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"type": "public",
"rank": 3,
"quota": -1,
"price": 1999,
"name": "new_name",
"locked": false,
"limits": [
{
"value": -1,
"name": "query_string_support",
"label": "label"
},
{
"value": 2,
"name": "number_of_pages",
"label": "label"
},
{
"value": 1,
"name": "variation_per_page",
"label": "label"
},
{
"value": 10,
"name": "static_sections",
"label": "label"
},
{
"value": 5,
"name": "sections_total",
"label": "label"
},
{
"value": 10,
"name": "hosted_files",
"label": "label"
},
{
"value": 500000,
"name": "size_per_file",
"label": "label"
},
{
"value": 10,
"name": "api_limit_sec",
"label": "label"
},
{
"value": 100,
"name": "api_limit_minute",
"label": "label"
},
{
"value": 100,
"name": "api_limit_hour",
"label": "label"
},
{
"value": 500,
"name": "api_limit_day",
"label": "label"
},
{
"value": -1,
"name": "dynamic_section_types_support",
"label": "label"
},
{
"value": 2,
"name": "users",
"label": "label"
},
{
"value": 5,
"name": "domains",
"label": "label"
}
],
"label": "Free"
}
Response
400
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-RX29imSS-wEABCzh
access-control-allow-origin: http://clientapp.com:3001
{
"message": "Packages already exist"
}
Used to create a package
Request
POST api/v1/auth/package
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Package Resource | Package |
| 400 | Error Resource | Error |
Get package by id
Get package by ID
GET /api/v1/auth/package/649abe0884307f02e1e8065c
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACBhZDJmMGUwZjVkMGU0NjBhYWJlMmI5NWEzNGQwZWRiOW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYArk12_IgBYgABUYA.sxR8QX-UD5NAK6KW-CSj3So9eP5Cr4yAYQXJ00BIpmk
origin: http://ae27c582-01c1-40fa-a74f-14c42e0d223b.com
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-REkFXU_SyzEAA8eC
access-control-allow-origin: http://clientapp.com:3001
{
"type": "public",
"rank": 3,
"quota": -1,
"price": 1999,
"name": "package_by_id",
"locked": false,
"limits": [
{
"value": -1,
"name": "query_string_support"
},
{
"value": 2,
"name": "number_of_pages"
},
{
"value": 1,
"name": "variation_per_page"
},
{
"value": 10,
"name": "static_sections"
},
{
"value": 5,
"name": "sections_total"
},
{
"value": 10,
"name": "hosted_files"
},
{
"value": 500000,
"name": "size_per_file"
},
{
"value": 10,
"name": "api_limit_sec"
},
{
"value": 100,
"name": "api_limit_minute"
},
{
"value": 100,
"name": "api_limit_hour"
},
{
"value": 500,
"name": "api_limit_day"
},
{
"value": -1,
"name": "dynamic_section_types_support"
},
{
"value": 2,
"name": "users"
},
{
"value": 5,
"name": "domains"
}
],
"label": "Free",
"id": "649abe0884307f02e1e8065c"
}
Used to retrieve a package by its id.
Request
GET api/v1/auth/package/:id
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Package Resource | Package |
| 400 | Error Resource | Error |
| 404 | Error Resource | Error |
Edit package by id
UPDATE package/
PUT /api/v1/auth/package/649abe0984307f02e15417e2
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACBkMzY2MGJiMjVmNWI0NmQ0YWY0YzE1ZWZlOGQ2ODI0MW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAalN2_IgBYgABUYA.9QsDc6L5SpTBZAAwehr3jQ9SDIjM-Gs872yhP7CxVd8
origin: http://8a1b3829-26a3-4936-afd9-d0b010ee9918.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"name": "premium",
"limits": [
{
"value": -1,
"name": "query_string_support",
"label": "label"
},
{
"value": 20,
"name": "number_of_pages",
"label": "label"
},
{
"value": 1,
"name": "variation_per_page",
"label": "label"
},
{
"value": 10,
"name": "static_sections",
"label": "label"
},
{
"value": 5,
"name": "sections_total",
"label": "label"
},
{
"value": 7,
"name": "hosted_files",
"label": "label"
},
{
"value": 500000,
"name": "size_per_file",
"label": "label"
},
{
"value": 10,
"name": "api_limit_sec",
"label": "label"
},
{
"value": -1,
"name": "api_limit_hour",
"label": "label"
},
{
"value": 100,
"name": "api_limit_minute",
"label": "label"
},
{
"value": 500,
"name": "api_limit_day",
"label": "label"
},
{
"value": -1,
"name": "dynamic_section_types_support",
"label": "label"
},
{
"value": 2,
"name": "users",
"label": "label"
},
{
"value": 5,
"name": "domains",
"label": "label"
}
],
"label": "premium"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-RJ-sD0Tz_GUAA8gi
access-control-allow-origin: http://clientapp.com:3001
{
"type": "public",
"rank": 3,
"quota": -1,
"price": 1999,
"name": "premium",
"locked": false,
"limits": [
{
"value": -1,
"name": "query_string_support"
},
{
"value": 20,
"name": "number_of_pages"
},
{
"value": 1,
"name": "variation_per_page"
},
{
"value": 10,
"name": "static_sections"
},
{
"value": 5,
"name": "sections_total"
},
{
"value": 7,
"name": "hosted_files"
},
{
"value": 500000,
"name": "size_per_file"
},
{
"value": 10,
"name": "api_limit_sec"
},
{
"value": -1,
"name": "api_limit_hour"
},
{
"value": 100,
"name": "api_limit_minute"
},
{
"value": 500,
"name": "api_limit_day"
},
{
"value": -1,
"name": "dynamic_section_types_support"
},
{
"value": 2,
"name": "users"
},
{
"value": 5,
"name": "domains"
}
],
"label": "premium",
"id": "649abe0984307f02e15417e2"
}
Used to edit a package by its id.
Request
PUT api/v1/auth/package/:id
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| package_id | The package id in Sections | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Package Resource | Package |
| 400 | Error Resource | Error |
| 404 | Error Resource | Error |
Duplicate package by id
Duplicate package
POST /api/v1/auth/package/649abe0d84307f02e17e2d97/duplicate
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACA4ZTA4NDk2MWFjZjk0NmI2YjAzYjgyNzcxYjZiODg0N20AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYA_WN2_IgBYgABUYA.aviPPWhr3I0e-WSzYUFDaCRzq9yH5QX0xO_aHezbS8k
origin: http://4d068359-47db-4986-9464-f916c5c11795.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"name": "package 2"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F2x-RZ2ehZZmmrAABC0B
access-control-allow-origin: http://clientapp.com:3001
{
"type": "public",
"rank": 3,
"quota": -1,
"price": 1999,
"name": "package 2",
"locked": false,
"limits": [
{
"value": -1,
"name": "query_string_support"
},
{
"value": 2,
"name": "number_of_pages"
},
{
"value": 1,
"name": "variation_per_page"
},
{
"value": 10,
"name": "static_sections"
},
{
"value": 5,
"name": "sections_total"
},
{
"value": 10,
"name": "hosted_files"
},
{
"value": 500000,
"name": "size_per_file"
},
{
"value": 10,
"name": "api_limit_sec"
},
{
"value": 100,
"name": "api_limit_minute"
},
{
"value": 100,
"name": "api_limit_hour"
},
{
"value": 500,
"name": "api_limit_day"
},
{
"value": -1,
"name": "dynamic_section_types_support"
},
{
"value": 2,
"name": "users"
},
{
"value": 5,
"name": "domains"
}
],
"label": "Free",
"id": "649abe0d84307f02e17e2d98"
}
Used to duplicate a package by its id.
Request
GET api/v1/auth/package/:id/duplicate
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| name | Name of the package to be used when duplicating | body | string | true | Eweev Package #1 |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Package Resource | Package |
| 400 | Error Resource | Error |
| 404 | Error Resource | Error |