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": [
"[email protected]",
"[email protected]"
],
"failed_to_send": [
"[email protected]"
],
"demotion": [
"[email protected]"
]
}
| 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 |
Payload
This is the registration payload to send to social connection flows.
{
"user": {
"role": "webmaster",
"invited_at": 1652524584,
"email": "[email protected]"
},
"project": {
"title": "My test project",
"project_url": [
"https://your.project.url.com"
],
"login_redirect_url": "https://your.project.url.com/redirect_login/admin",
"configured_fields": {
"blogs ": {
"project_id": 1,
"private_key": "xxxxxx"
}
}
},
"page": "true"
}
| Property | Description | Type | Required |
|---|---|---|---|
| page | Page creation | boolean | false |
| project | A Project that a user owns in sections it contains the project credentials and configurations | Project | true |
| user | This is Section's user model. It contains all the information that sections needs to know about you. | User | true |
Pending_Invitation
This is the response of the get pending_invitation API call.
{
"users": [
{
"role": "webmaster",
"invited_at": 1652524584,
"email": "[email protected]"
}
],
"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/68cd487184307f02fc56860f/token/DD239F767BE6004A2C08C8416E41EC82
origin: http://58e59f34-eae2-4355-a50f-d1dfa628993a.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAR1c2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0ODcxODQzMDdmMDJmYzU2ODYwZmptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDQ3MTc5ZDJmNjhhODQyNjZhNTdkMDZlMjI4MDRkOGNmbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBv_OJhmQFiAAFRgA.viFgxzJJ0ozEvUCnD1eu5sxD-JMllcj7-81eFU3c9xc
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat4ctCMsHHLMMABEUC
content-type: application/json; charset=utf-8
access-control-allow-origin: http://58e59f34-eae2-4355-a50f-d1dfa628993a.com
{
"token": "SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAR1c2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0ODcxODQzMDdmMDJmYzU2ODYwZmptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDQ3MTc5ZDJmNjhhODQyNjZhNTdkMDZlMjI4MDRkOGNmbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBv_OJhmQFiAAFRgA.viFgxzJJ0ozEvUCnD1eu5sxD-JMllcj7-81eFU3c9xc"
}
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 (can be replaced by project domain) | 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 with project_id
POST /api/v1/project/68cd47d584307f02fc5ce077/page/page-path-f0a2b28f-334b-4051-ba2f-ffcaa6f4f315
origin: http://f1b11626-7c79-4bc5-aef0-5335508a4ca1.com
user-agent: user-agent-d168db05-147d-4d92-91c6-234227372519
project-id-65223ffe-00a6-470b-8db8-26c66fbb2d71: 1
content-type: multipart/mixed; boundary=plug_conn_test
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatvcBXrVh3BXoABDVi
content-type: application/json; charset=utf-8
access-control-allow-origin: http://f1b11626-7c79-4bc5-aef0-5335508a4ca1.com
{
"variations": null,
"sections": [
{
"weight": 1,
"type": "static",
"status_code": null,
"settings": {},
"render_data": "",
"region": {},
"query_string_keys": null,
"private_data": {},
"name": "section_name_ae6a9b51-136a-48ae-a600-01a8ede4014e",
"linked_to": "",
"id": "68cd47d684307f02fcd621d8",
"error": null
}
],
"path": "page-path-f0a2b28f-334b-4051-ba2f-ffcaa6f4f315",
"page": "page_55780568-336b-4d53-a0a7-b96346e3e432",
"metadata": {
"project_metadata": {},
"package": {
"name": "solo",
"label": "Standard"
}
},
"layout": "layout1",
"last_updated": 1758283734,
"invalid_sections": [],
"id": "68cd47d6052f5069671c056a"
}
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 (can be replaced by project domain) | 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/68cd47cc84307f02fcdb6213/page/page_4c69f3ba-5784-4655-ba2d-9c4bf2124311
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2NjODQzMDdmMDJmY2RiNjIxM2ptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGE1NzYyNTI5ZjRiYTRjNmI5MGY2MDdhYmE2YTcyYjlibQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgD0d-BhmQFiAAFRgA.SHznxp8hMdjqykaI19xkKCexe7OVkYdHNLgi3nqHpwo
origin: http://2994a6eb-839b-4b0d-b888-6fcaa2eacc59.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"variations": [
"1"
],
"sections": [
{
"weight": 1,
"region": {
"layout1": {
"weight": 1,
"slot": "main"
}
},
"private_data": {
"data": "test123"
},
"options": [
{
"image": {
"media_id": "68cd47ce84307f02fceb97a2"
}
}
],
"name": "section_name_3792da3e-676e-4450-84a8-54640917a3bc"
}
],
"path": "my-page-path",
"metadata": {
"title": "Page Title",
"description": "Page SEO Description"
},
"layout": "layout1"
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatu-v0CQ-vZYMABMOB
content-type: application/json; charset=utf-8
access-control-allow-origin: http://2994a6eb-839b-4b0d-b888-6fcaa2eacc59.com
{
"variations": [
"1"
],
"sections": [
{
"weight": 1,
"type": "static",
"status_code": null,
"settings": [
{
"image": {
"url": "https://www.fake-url.com/fb7d22659b1e46aeba4ed57a0d7fd7a6",
"seo_tag": null,
"metadata": null,
"media_id": "68cd47ce84307f02fceb97a2"
}
}
],
"render_data": "",
"region": {
"layout1": {
"weight": 1,
"slot": "main"
}
},
"query_string_keys": null,
"private_data": {
"data": "test123"
},
"name": "section_name_3792da3e-676e-4450-84a8-54640917a3bc",
"linked_to": "",
"id": "68cd47cf84307f02fcb1c2dd",
"error": null
}
],
"path": "my-page-path",
"page": "page_4c69f3ba-5784-4655-ba2d-9c4bf2124311",
"metadata": {
"title": "Page Title",
"description": "Page SEO Description"
},
"layout": "layout1",
"last_updated": 1758283727,
"invalid_sections": [],
"id": "68cd47cf052f5069671c03e4"
}
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.
To use a global section instance in a page you add a section object with a weight and the name of the global section in the linked_to field. For ex:
{
"sections": [{
"weight": 2,
"linked_to": "test"
}]
}
The content of the global instance will automatically be added to your page and any update to the global instance will be synchronized inside your page
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 (can be replaced by project domain) | 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/68cd47e484307f02fca26174/page/68cd47e4052f5069671c0704
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2U0ODQzMDdmMDJmY2EyNjE3NGptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGUwZmU4MWYzZDBhZjQ0NTI5ZjM2YjdlZmE1ZTEwZjY2bQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgCo0-BhmQFiAAFRgA.ja84DAGhXLREtjcaYOAUrxI4Rvt08gPDl6NYGECf00Q
origin: http://63b50679-4726-4a6f-b703-e6c8ce8aca0c.com
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatwN6UvKnOOs4ABOLh
content-type: application/json; charset=utf-8
access-control-allow-origin: http://63b50679-4726-4a6f-b703-e6c8ce8aca0c.com
{
"message": "Successfully deleted 68cd47e4052f5069671c0704"
}
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 (can be replaced by project domain) | 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/68cd47c884307f02fc5ee803/section-types
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2M4ODQzMDdmMDJmYzVlZTgwM2ptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGFlMjgxNGQ3NjQ5ZTQyZWNhMWUwMDM1ZWYwMjdiODljbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgCPZ-BhmQFiAAFRgA.vbCf5b_uySe17oKE-wcBUdrN3k1VPO1PuCGGpRNaLKw
origin: http://f9652ddf-fe27-4b18-9d37-e776a8c342f8.com
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatumQ0ceCcxNgABLXh
content-type: application/json; charset=utf-8
access-control-allow-origin: http://f9652ddf-fe27-4b18-9d37-e776a8c342f8.com
{
"data": [
{
"type": "static",
"name": "wysiwyg",
"multiple": false,
"id": "68cd47c1052f5069671c0148",
"fields": null,
"dynamic_options": false,
"application_id": null,
"application": "sections",
"access": "public"
}
]
}
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 (can be replaced by project domain) | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | List of section types resource | Section_Type |
| 401 | Error Resource | Error |
Edits a global section instance
Edit a global Section instance
PUT /api/v1/project/68cd47cf84307f02fcb1c2e0/global-instances/global_section
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2NmODQzMDdmMDJmY2IxYzJlMGptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDEwMjMzNmY0NWI4NTQ1M2I4MjJjZmQ5YTY4YTliMmE3bQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgCChOBhmQFiAAFRgA.5Y6nsNK7z6onAaT8I9Y0iTTB-dvlm54fuSBZ5GU6qWU
origin: http://93b7a032-5e78-4dda-b399-bbf43cb2a21e.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"section": {
"type": "static",
"name": "wysiwyg"
},
"auto_insertion": false
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatvCX8zaeu0PAABHXj
content-type: application/json; charset=utf-8
access-control-allow-origin: http://93b7a032-5e78-4dda-b399-bbf43cb2a21e.com
{
"section": {
"type": "static",
"name": "wysiwyg"
},
"pages": [],
"name": "global_section",
"id": "68cd47d084307f02fcc7dae0",
"auto_insertion": false
}
Edits an existing standalone section that you can use in multiple pages. Editing this global section instance will update it on all the pages where its being used.
Request
PUT api/v1/project/:project_id/global-instances/:name
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| project_id | Your project id in Sections (can be replaced by project domain) | 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 |
Deletes a global section instance by its name
Delete a specific Global Sections by its name
DELETE /api/v1/project/68cd47ca84307f02fcf3467e/global-instances/global_section
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2NhODQzMDdmMDJmY2YzNDY3ZWptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDE1OTIwYzZmNDAyNTRlZjNiOWI0OGZkMmZhNWI2Y2EybQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgChbuBhmQFiAAFRgA.hQazEciGySMw1jYlDI9VAnLGntDRS5THVKjCI-nlMHo
origin: http://6a6aacad-77d3-4769-8ff6-03d4a53a6549.com
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatutd47k0LWh0ABAmi
content-type: application/json; charset=utf-8
access-control-allow-origin: http://6a6aacad-77d3-4769-8ff6-03d4a53a6549.com
{
"message": "Deleted successfully."
}
Removes the Global Instance from the project. If the Global Instance is being used in a page it can't be removed
Request
DELETE api/v1/project/:project_id/global-instances/:name
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| project_id | Your project id in Sections (can be replaced by project domain) | 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 |
| 423 | Error Resource Locked | Error |
Creates a static section type
Create Static ST
POST /api/v1/project/68cd47c584307f02fcae73ca/section-types/section_name_e76c6cfe-8b73-4880-add2-49ea8fa6bad9
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2M1ODQzMDdmMDJmY2FlNzNjYWptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDQ5MmQ2NzAzNjIxNDRiNmQ4N2Y3MWRiODlhNmNlOTVjbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBqXeBhmQFiAAFRgA.84317ZdtqiK_Xk0X7yjJyx9RPwKv0bo0t4XbRrKWHas
origin: http://35db48df-162f-4d52-84c9-dc23abb6dc57.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"fields": [
{
"type": "image",
"name": "profile"
},
{
"type": "image",
"name": "profile1"
}
]
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatuclrEJHIV9UABHVD
content-type: application/json; charset=utf-8
access-control-allow-origin: http://35db48df-162f-4d52-84c9-dc23abb6dc57.com
{
"type": "static",
"name": "section_name_e76c6cfe-8b73-4880-add2-49ea8fa6bad9",
"multiple": false,
"id": "68cd47c684307f02fc347ee2",
"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 (can be replaced by project domain) | 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 |
Renders the requested section's data
Render an existing ST
POST /api/v1/project/68cd47c984307f02fcca3acb/section/render
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2M5ODQzMDdmMDJmY2NhM2FjYmptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDc1NzZmZjRmNjk2ZTQ2M2VhZjU2MzA4ODllNDE0NGE1bQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBbbOBhmQFiAAFRgA.kzQnK_SZLljNRmvLQhMOCcN7jGVr2o0xDB8lP6F_If0
origin: http://01b2bc06-7490-4590-8533-f4078a151c3f.com
user-agent: user-agent-71e94de4-39f0-42f9-b9d7-b3171b2d1287
project-id-57414613-92ad-4782-8739-9cd4600969ca: 1
content-type: multipart/mixed; boundary=plug_conn_test
{
"section": {
"weight": 1,
"name": "section_name_d9c0645a-efba-4581-b939-808c74593722"
}
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGaturZfINu6okUABLiB
content-type: application/json; charset=utf-8
access-control-allow-origin: http://01b2bc06-7490-4590-8533-f4078a151c3f.com
{
"weight": 1,
"type": "static",
"status_code": null,
"settings": {},
"render_data": "",
"region": {},
"query_string_keys": null,
"private_data": {},
"name": "section_name_d9c0645a-efba-4581-b939-808c74593722",
"linked_to": "",
"id": "68cd47ca84307f02fcf3467c",
"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 (can be replaced by project domain) | 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'} } | |
| base_path | The path of the page, to relay to third party backend app in the context for rendering | query_string | string | false |
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/68cd47cd84307f02fc9cf3d1/section/68cd47cd84307f02fc9cf3d2%3Aselective_articles/options
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2NkODQzMDdmMDJmYzljZjNkMWptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDkwMDZmOGFkZjIxYTRkNGY4ZWM0OTQzNGQxNGVhYzljbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBXeeBhmQFiAAFRgA.GuQWQRqqsETlu6SmxpmOJeiCzFAnEiQGI2qOG_uMJoc
origin: http://c1ad4cf9-cfb6-4ba5-882f-80d1a2339b7a.com
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatu7NtXjfpYeAABL2B
content-type: application/json; charset=utf-8
access-control-allow-origin: http://c1ad4cf9-cfb6-4ba5-882f-80d1a2339b7a.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 (can be replaced by project domain) | 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/68cd47cc84307f02fcdb6211/section-types/section_name_ab806092-7837-4a17-80af-cf8ff8d94b3c
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2NjODQzMDdmMDJmY2RiNjIxMWptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGFjYTU3ZTQxMDNlYTQ2ZjBhOTFjYTEzOWY5NGJjMmM3bQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgAFd-BhmQFiAAFRgA.ea9fWDDdNWTMEIXiMUf22VxeJtuLDm4J0gbsy4FPx-Y
origin: http://7291779b-04d9-4971-b9c6-c9ec855fcc6f.com
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatu1d5Ud4tOmsABBkC
content-type: application/json; charset=utf-8
access-control-allow-origin: http://7291779b-04d9-4971-b9c6-c9ec855fcc6f.com
{
"message": "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 (can be replaced by project domain) | query_string | string | true | ||
| section_name | Section name | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | message resource | Message |
| 404 | Error Resource | Error |
Update the authorization fields for the considered app on your project
Upsert authorization fields for an application
PUT /api/v1/project/68cd47c484307f02fc4c8c80/authorization_fields/123456
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2M0ODQzMDdmMDJmYzRjOGM4MGptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDQ4ZmE4NGU1NWY4OTQ4Mjc4YmEzYmNiZTI2NWU0NjVlbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgAYVuBhmQFiAAFRgA.iIzcI-zwt45w_84FEU-8oM64hqS5EZWIMRkKAv96pA0
origin: http://c892ccdd-748f-4605-8e13-47732aa93022.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"authorization_fields": {
"project_id": 38,
"private_key": "private_key_hashed"
}
}
Response
404
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatuVm9w1IGuCgABGyj
content-type: application/json; charset=utf-8
access-control-allow-origin: http://c892ccdd-748f-4605-8e13-47732aa93022.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 (can be replaced by project domain) | 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 |
Creates a global section instance
Create a global Section instance
POST /api/v1/project/68cd47c484307f02fc4c8c82/global-instances/global_section
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2M0ODQzMDdmMDJmYzRjOGM4MmptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGNmYmM1MWQzZDBjNTRjMDg5OGQxZDIwMTY0NmU5OTk1bQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgCRV-BhmQFiAAFRgA.ZI5bh-cZFT5RnrYz_qozw7uNVAW7F1L25FJZy6rgaYw
origin: http://1cd079dd-2ec4-4b08-ae54-29914c8bd676.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"section": {
"weight": 2,
"type": "static",
"options": [
{
"data": "Test Wysiwyg content"
}
],
"name": "wysiwyg"
},
"regions": {
"standard": 1
}
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatuXAzpOgnq-sABKvB
content-type: application/json; charset=utf-8
access-control-allow-origin: http://1cd079dd-2ec4-4b08-ae54-29914c8bd676.com
{
"section": {
"weight": 2,
"type": "static",
"options": [
{
"data": "Test Wysiwyg content"
}
],
"name": "wysiwyg"
},
"pages": [],
"name": "global_section",
"id": "68cd47c484307f02fc4c8c84",
"auto_insertion": false
}
Creates a standalone section that you can use in multiple pages. Editing this global section instance will update it on all the pages where its being used.
Request
POST api/v1/project/:project_id/global-instances/:name
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| project_id | Your project id in Sections (can be replaced by project domain) | query_string | string | true | ||
| global_instance_name | Global Instance name | query_string | string | true | ||
| section | A map containing the section name and its order (weight) in the page | body | map | true | {section: {name: '6038e54de3ba240007b07913:categories_articles', weight: '1'} } | |
| auto_insertion | Indicate whether this section should be automatically added when a new page is being created. No effect on the API, just an indication to the page creator application | body | boolean | false |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Global section instance | Section_Type |
| 400 | Error Resource | Error |
| 401 | Error Resource | Error |
List global section instances of a given project
List Global Sections of a given project
GET /api/v1/project/68cd47d284307f02fc53ba0d/global-instances
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2QyODQzMDdmMDJmYzUzYmEwZGptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDZmNzdlYjJlNDQwNDRhNGU4ZmIzZTg3NzU5YjJmYmYwbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBtj-BhmQFiAAFRgA.UoLB1Rc6EPelxvMBjJmtTUbZ7Akt8yTNcBQFRRBuepc
origin: http://57dfd516-c552-4a4a-950c-6bde6d33980d.com
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatvNKgh5YZgfwABC9i
content-type: application/json; charset=utf-8
access-control-allow-origin: http://57dfd516-c552-4a4a-950c-6bde6d33980d.com
{
"total": 2,
"data": [
{
"section": {
"type": "static",
"name": "wysiwyg"
},
"pages": [],
"name": "global_section",
"id": "68cd47d284307f02fc53ba0f",
"auto_insertion": false
},
{
"section": {
"type": "static",
"name": "wysiwyg"
},
"pages": [],
"name": "global_section_2",
"id": "68cd47d284307f02fc53ba11",
"auto_insertion": false
}
]
}
List all the Global instances of a given project
Request
GET api/v1/project/:project_id/global-instances
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| project_id | Your project id in Sections (can be replaced by project domain) | query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | section type resource | Section_Type |
| 400 | Error Resource | Error |
| 401 | Error Resource | Error |
Get a global section instance by its name
Get a specific Global Sections by its name
GET /api/v1/project/68cd47d084307f02fcc7dae6/global-instances/global_section
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2QwODQzMDdmMDJmY2M3ZGFlNmptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGZkNjBiZWNmMmVkZTRmNjJiNjg2OWM1NDg2Y2I3ZjE0bQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBoiOBhmQFiAAFRgA.IPL-zHVgYTsFHisAU1JId2qw_LZGWLbLh48lURF1CkE
origin: http://4ca3de06-f255-4804-ad47-60ee198dc4b5.com
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatvGEN4-a9N7kABNDB
content-type: application/json; charset=utf-8
access-control-allow-origin: http://4ca3de06-f255-4804-ad47-60ee198dc4b5.com
{
"section": {
"type": "static",
"name": "wysiwyg"
},
"pages": [],
"name": "global_section",
"id": "68cd47d184307f02fcecceee",
"auto_insertion": false
}
Returns the global instance with the provided name that belongs to the project
Request
GET api/v1/project/:project_id/global-instances/:name
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| token | Sections Token | header | string | true | ||
| project_id | Your project id in Sections (can be replaced by project domain) | 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 |
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/68cd48a784307f02fc30eec5/active_package
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAR1c2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0OGE3ODQzMDdmMDJmYzMwZWVjNWptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDUyMDRiYzliOWQzYjQ3Y2NhYzIzOTM1MjNlMGRmMWExbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgAZz-NhmQFiAAFRgA.HJnENe7xLKYF9L3Ww3ZEOjFgAZMbQvw8a9Dd0bjpiWo
origin: http://d5fb0b76-f55f-4686-8342-61cbe7bc4187.com
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat7mHVgJOO13AABQeB
content-type: application/json; charset=utf-8
access-control-allow-origin: http://d5fb0b76-f55f-4686-8342-61cbe7bc4187.com
{
"usage": null,
"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": "68cd47c184307f02fc110d28"
}
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 (can be replaced by project domain) | 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/68cd48a884307f02fcc51f3c/packages
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAVhZG1pbm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2OGNkNDhhODg0MzA3ZjAyZmNjNTFmM2NqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACAwMzQwYjAwN2Q3MGM0ZWVjYmJhNmZjMGJmNmQ2MjU1NG0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAZ9LjYZkBYgABUYA.qKHwlB6lWKfjPu05Uyuk4WrfpOkChQpraaTnnbSQwfc
origin: http://5e1a014e-83a8-4bda-8a0f-307a1f7785cf.com
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat7olMakQeZakABQgB
content-type: application/json; charset=utf-8
access-control-allow-origin: http://5e1a014e-83a8-4bda-8a0f-307a1f7785cf.com
{
"total": 11,
"data": [
{
"usage": null,
"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": "68cd47c184307f02fc110d2a"
},
{
"usage": null,
"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": "68cd47c184307f02fc110d28"
},
{
"usage": null,
"type": "public",
"rank": 3,
"quota": -1,
"price": 1999,
"name": "new_name",
"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": "68cd489f84307f02fc51343c"
},
{
"usage": null,
"type": "public",
"rank": 3,
"quota": -1,
"price": 1999,
"name": "package 1",
"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": "68cd48a684307f02fc94b182"
},
{
"usage": null,
"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": "68cd48a684307f02fc94b183"
},
{
"usage": null,
"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": "68cd48a084307f02fc5466d7"
},
{
"usage": null,
"type": "public",
"rank": 5,
"quota": -1,
"price": 10,
"name": "qs_enabled",
"locked": false,
"limits": [
{
"value": -1,
"name": "query_string_support"
},
{
"value": 3,
"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": "QS_enabled",
"id": "68cd47d184307f02fceccef2"
},
{
"usage": null,
"type": "public",
"rank": 1,
"quota": 1,
"price": 0,
"name": "quota_1",
"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": -1,
"name": "api_limit_hour"
},
{
"value": -1,
"name": "api_limit_minute"
},
{
"value": 500,
"name": "api_limit_day"
},
{
"value": 0,
"name": "dynamic_section_types_support"
},
{
"value": 1,
"name": "users"
},
{
"value": 1,
"name": "domains"
}
],
"label": "quota_1_label",
"id": "68cd47c784307f02fccc200e"
},
{
"usage": null,
"type": "public",
"rank": 1,
"quota": 0,
"price": 0,
"name": "quota_register",
"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": -1,
"name": "api_limit_hour"
},
{
"value": -1,
"name": "api_limit_minute"
},
{
"value": 500,
"name": "api_limit_day"
},
{
"value": 0,
"name": "dynamic_section_types_support"
},
{
"value": 1,
"name": "users"
},
{
"value": 1,
"name": "domains"
}
],
"label": "quota_r_label",
"id": "68cd489b84307f02fc4229c5"
},
{
"usage": null,
"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,
"unit_size": 100,
"unit_price": 2,
"name": "api_limit_day",
"included": 5
},
{
"value": 0,
"name": "dynamic_section_types_support"
},
{
"value": 2,
"name": "users"
},
{
"value": 1,
"name": "domains"
}
],
"label": "Standard",
"id": "68cd47c184307f02fc110d29"
},
{
"usage": null,
"type": "public",
"rank": 3,
"quota": -1,
"price": 1999,
"name": "something",
"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": "68cd489d84307f02fc742c3f"
}
]
}
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 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 (can be replaced by project domain) | 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 with root page
POST /api/v1/register
origin: http://clientapp.com:3001
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAR1c2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0ODZiODQzMDdmMDJmYzc3MzE5MmptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGZkMmM2ZmRmNGM5NDQ5NTI4NjYxZmNlNGNmNzEwM2NlbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBB5eJhmQFiAAFRgA.7sB5H8WpCBOK4m8Y7U81AEI9xQJdNGuUYU3faXsR4A8
content-type: multipart/mixed; boundary=plug_conn_test
{
"user": {
"terms_conditions": true,
"password": "password",
"full_name": "Fullname",
"email": "[email protected]"
},
"project": {
"title": "Your Project Title",
"project_url": [
"your.great_url.com"
],
"login_redirect_url": "https://your.great_url.com"
},
"page": true
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat4G8u35wto9AABO8B
content-type: application/json; charset=utf-8
access-control-allow-origin: http://clientapp.com:3001
{
"data": {
"user": {
"user_id": "123userid123",
"saas_project_id": [
{
"title": "Your Project Title",
"saas_project_id": "68cd486c84307f02fca69449",
"role": "admin"
}
],
"last_login": 1758283884,
"full_name": "Someone",
"email": "[email protected]"
},
"token": {
"token": "this is a token"
},
"project": {
"type": "private",
"title": "Your Project Title",
"section_types_count": null,
"reason": null,
"project_url": [
"your.great_url.com"
],
"private_packages": null,
"private_key": "$2b$12$nHRBigMt.C7TrlUS.Ac63.0oOMVgV/Toxspa9wN8zOe/6KEEJgfSG",
"pages_count": null,
"package_label": null,
"package": {
"type": "public",
"rank": 0,
"quota": -1,
"project_id": null,
"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": "68cd47c184307f02fc110d28",
"currency": "EUR"
},
"metadata": {},
"login_redirect_url": "https://your.great_url.com",
"limits": null,
"limitation_status": "active",
"last_req_date": null,
"inserted_at": 1758283884,
"id": "68cd486c84307f02fca69449",
"files_counter": 0,
"configured_fields": {},
"billing_status": "upgrade_lock",
"active": true
}
}
}
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: '[email protected]', password: 'new_pass', current_pass: 'current_pass'} } | |
| page | Create a root page if true | body | false |
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/68cd485c84307f02fc1cd7df/pending_invitations
origin: http://16b2ea2b-2ea8-4652-932a-742a89b7533a.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAVhZG1pbm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2OGNkNDg1Yzg0MzA3ZjAyZmMxY2Q3ZGZqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACBhMWUwMTQzOTY4NzY0ZDQ5OWQwZDFkYWU2OTI3NmZjYW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAlqriYZkBYgABUYA.h0bxtYe2BSeyragXQu5bsbhUPF7r0ij4qJQTr73CoL4
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat3O_2LoM_ua8ABEDi
content-type: application/json; charset=utf-8
access-control-allow-origin: http://16b2ea2b-2ea8-4652-932a-742a89b7533a.com
{
"users": [
{
"role": "webmaster",
"invited_at": 1758283868,
"email": "[email protected]"
}
],
"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 (can be replaced by project domain) | 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/68cd485e84307f02fc4fc3cb/user
origin: http://4b8c20b0-13ff-42aa-9d11-9fbb3538437d.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAl3ZWJtYXN0ZXJtAAAAD3NhYXNfcHJvamVjdF9pZG0AAAAYNjhjZDQ4NWU4NDMwN2YwMmZjNGZjM2Niam0AAAAGc3RhdHVzbQAAAAh2ZXJpZmllZG0AAAAHdXNlcl9pZG0AAAAgMzdjMTlkZDQ4N2M1NGI1NjgwZTQ0YmNiMTBkMzJhZWVtAAAABnN0YXR1c20AAAAHc3VjY2Vzc24GAG-y4mGZAWIAAVGA.TQrwhhRuDpxZbGZnCgY90ptO-eIJFAsVHSxot3V1Pa4
{
"aspect": "body_params"
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat3V81BpigPT8ABEGC
content-type: application/json; charset=utf-8
access-control-allow-origin: http://4b8c20b0-13ff-42aa-9d11-9fbb3538437d.com
{
"token": null,
"status": null,
"roles": null,
"projects": [
{
"saas_project_id": "68cd485e84307f02fc4fc3cb",
"role": "admin"
}
],
"inserted_at": null,
"id": "1",
"full_name": "Full Name",
"email": "[email protected]"
}
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 (can be replaced by project domain) | 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 |
Get the Social Redirect url
Social redirect link checks registration data is correct early
POST /api/v1/social_redirect/google
origin: http://clientapp.com:3001
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAR1c2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0ODY1ODQzMDdmMDJmY2RmMWU0N2ptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGMwYzc4NDRkZjk2YzQ5ZjdhYzJmMWFhOTlmZTI3NWQ5bQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgCpzuJhmQFiAAFRgA.4f9dFQCiMeMiV-ARmhZW90JMUddQY63GHbiImQwtJjU
content-type: multipart/mixed; boundary=plug_conn_test
{
"redirect_uri": "http://redirect",
"payload": {
"user": {
"terms_conditions": true,
"full_name": "Fullname"
},
"project": {
"title": "Your Project Title",
"project_url": [
"your.social_url.com"
],
"login_redirect_url": "https://your.social_url.com"
}
}
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat3xe1jzlXm60ABEKC
content-type: application/json; charset=utf-8
access-control-allow-origin: http://clientapp.com:3001
{
"url": "register"
}
This is used to allow Sections users to will return the url you should redirect the user to at the social connect provider.
It will ask the user to grant permission to Sections to connect to the user account and grant permissions based on the scopes you request.
The provider supported today is google
The redirect_uri query parameter is mandatory.
The scope[] list is optional, by default the email is requested
Request
POST api/v1/social_redirect/{provider}?redirect_uri={redirect_uri}&scope[]={scope_1}&scope[]={scope_2}
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| payload | Registration payload | body | Payload | false |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Redirect URL | string |
Connect the user using his social credentials
Social connection automatically verifies the user
POST /api/v1/social_connect/google
origin: http://clientapp.com:3001
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAR1c2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0ODYzODQzMDdmMDJmYzFkMTkxM2ptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGViMDFmMmI4MGQyNTRlOWNhMjNmOGFlYjEyYWUyMDAzbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBBxeJhmQFiAAFRgA.UwrXoosfdGD4JJrYzphLfgf73AY7gNv1Lxt_8bMumI8
content-type: multipart/mixed; boundary=plug_conn_test
{
"redirect_uri": "http://redirect",
"payload": {
"user": {
"terms_conditions": true,
"full_name": "Fullname"
},
"project": {
"title": "Your Project Title",
"project_url": [
"your.social_url.com"
],
"login_redirect_url": "https://your.social_url.com"
}
},
"code": "code-123"
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat3odRBOKwCX8ABHhj
content-type: application/json; charset=utf-8
access-control-allow-origin: http://clientapp.com:3001
{
"data": {
"user": {
"user_id": "123userid123",
"saas_project_id": [
{
"title": "Your Project Title",
"saas_project_id": "68cd486484307f02fc9d78a8",
"role": "admin"
}
],
"full_name": "Full name",
"email": "[email protected]"
},
"token": {
"token": "this is a token"
},
"project": {
"type": "private",
"title": "Your Project Title",
"section_types_count": null,
"reason": null,
"project_url": [
"your.social_url.com"
],
"private_packages": null,
"private_key": "$2b$12$BrY9D6vHT/4NuVCZw5uDH.bbbSSFpeqvV.vQR7aSL4vn5hLz9KHT2",
"pages_count": null,
"package_label": null,
"package": {
"type": "public",
"rank": 0,
"quota": -1,
"project_id": null,
"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": "68cd47c184307f02fc110d28",
"currency": "EUR"
},
"metadata": {},
"login_redirect_url": "https://your.social_url.com",
"limits": null,
"limitation_status": "active",
"last_req_date": null,
"inserted_at": 1758283876,
"id": "68cd486484307f02fc9d78a8",
"files_counter": 0,
"configured_fields": {},
"billing_status": "upgrade_lock",
"active": true
}
}
}
This is meant to be called after you called the Social Redirect Url.
You should provide the code you collect from the Social Redirect Url flow alongside the redirect_uri and the list of fields you want from the social media.
The provider supported today is google
The redirect_uri query parameter is mandatory.
The fields[] list is optional
Request
POST api/v1/social_connect/{provider}?code={code}&redirect_uri={redirect_uri}&fields[]={field_1}&fields[]={field_2}
Parameters
| Parameter | Description | In | Type | Required | Default | Example |
|---|---|---|---|---|---|---|
| payload | Registration payload | body | Payload | false |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Login Operation | User |
| 400 | Error Resource | Error |
Verify your Sections account
Verify user
POST /api/v1/verify_user
origin: http://clientapp.com:3001
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAR1c2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0ODUwODQzMDdmMDJmYzBhZTBlZmptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDdkZmVmYmRmNzdjOTQ1ODliZTUyMWFkNDRhNGJmZWQybQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgDgfOJhmQFiAAFRgA.smr_83w1-lOQRT69kKvJ3xefJvWCztnS39RbGr-uZ0A
content-type: multipart/mixed; boundary=plug_conn_test
{
"token": "this is the token"
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat2jcGzVjv8fYABOuh
content-type: application/json; charset=utf-8
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.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAR1c2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0ODVhODQzMDdmMDJmYzczOTAxYWptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDk3NmFlOGI4YmFiZjQ4YWY5NzhlNTFjMTlhZTljOTk1bQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgC_oeJhmQFiAAFRgA.UgsWeaMWubgtWaFTKDU6rYviYrPbXSIW_w4xoT92CZk
content-type: multipart/mixed; boundary=plug_conn_test
{
"password": "password",
"email": "[email protected]"
}
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat3Gqq0yM76f0ABOxh
referrer-policy: strict-origin-when-cross-origin
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: SAMEORIGIN
x-permitted-cross-domain-policies: none
{
"token": {
"token": "this is a token"
},
"status": null,
"roles": null,
"projects": [
{
"title": null,
"saas_project_id": "68cd485a84307f02fc73901a",
"role": "webmaster"
}
],
"inserted_at": null,
"id": "123userid123",
"full_name": "Someone",
"email": "[email protected]"
}
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 (can be replaced by project domain) | 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/68cd487b84307f02fc5f4d29/user
origin: http://2c59ee5e-a627-4466-88ba-b23e195a8eb6.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAR1c2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0ODdiODQzMDdmMDJmYzVmNGQyOWptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDYxY2Q5ODEzZjJjYzQ0N2ZiOGZkMDBlYThmMjY1OGE1bQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgDKIuNhmQFiAAFRgA.4qnkwySUhLhxbCgBoRCdZ1LPkYVPeRSPo7_3_gk4B4g
content-type: multipart/mixed; boundary=plug_conn_test
{
"password": "new_password",
"full_name": "Your updated name",
"email": "[email protected]",
"current_password": "your_current_pass",
"confirm_password": "new_password"
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat5BGbpFxGDbAABEcC
content-type: application/json; charset=utf-8
access-control-allow-origin: http://2c59ee5e-a627-4466-88ba-b23e195a8eb6.com
{
"token": null,
"status": "pending",
"roles": null,
"projects": null,
"inserted_at": null,
"id": null,
"full_name": "Your updated name",
"email": "[email protected]"
}
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 (can be replaced by project domain) | query_string | string | true | ||
| token | Sections Token | header | string | true | ||
| user | User Model. | body | map | true | {email: '[email protected]', 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/68cd487584307f02fce6af9e/add_user
origin: http://68c2e934-8520-4cd8-8872-5fac8fe3e864.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAR1c2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0ODc1ODQzMDdmMDJmY2U2YWY5ZWptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDU0MGE3Mjc5YWViNzRlNzBhZDM3NzBkZDFiYjk5MGNkbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgCDCuNhmQFiAAFRgA.1vfv0qHtLHqnkH3QFT9bOy9Zl79VJJtR4v-NIdiyKug
content-type: multipart/mixed; boundary=plug_conn_test
{
"saas_project_id": "68cd487584307f02fce6af9e",
"role": "User",
"email": "[email protected]"
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat4p8ybFST7_cABPJB
content-type: application/json; charset=utf-8
access-control-allow-origin: http://68c2e934-8520-4cd8-8872-5fac8fe3e864.com
{
"token": null,
"status": null,
"roles": null,
"projects": [
{
"saas_project_id": "68cd487584307f02fce6af9e",
"role": "User",
"accepted_on": 1758283893
}
],
"inserted_at": null,
"id": "6f3ca5c0-50d9-4f17-ac21-e1fe797a8b65",
"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 (can be replaced by project domain) | 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/68cd485c84307f02fc1cd7df/invite_user
origin: http://16b2ea2b-2ea8-4652-932a-742a89b7533a.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAVhZG1pbm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2OGNkNDg1Yzg0MzA3ZjAyZmMxY2Q3ZGZqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACBhMWUwMTQzOTY4NzY0ZDQ5OWQwZDFkYWU2OTI3NmZjYW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAlqriYZkBYgABUYA.h0bxtYe2BSeyragXQu5bsbhUPF7r0ij4qJQTr73CoL4
content-type: multipart/mixed; boundary=plug_conn_test
{
"invitation_user_email": [
"[email protected]"
],
"invitation_role": "webmaster"
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat3Od-uvg_ua8ABECi
content-type: application/json; charset=utf-8
access-control-allow-origin: http://16b2ea2b-2ea8-4652-932a-742a89b7533a.com
{
"invited": [
"[email protected]"
],
"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 (can be replaced by project domain) | 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 | ['[email protected]','[email protected]'] |
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://335b67fe-0b9d-48b6-b2aa-b3cf112f2e03.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAR1c2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0ODYxODQzMDdmMDJmYzg3OTIyN2ptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGE2MmUxMTQ2NDRlODRiNzI4YzljZjA0MmY3ODQyYmJhbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgCNvOJhmQFiAAFRgA.gJMNUwKMenCxUOyfhMsx-NMia9xt_U0RLxSXizE2GQM
content-type: multipart/mixed; boundary=plug_conn_test
{
"invitation_token": "SFMyNTY.g2gDdAAAAANtAAAACnByb2plY3RfaWRtAAAAGDY4Y2Q0ODYxODQzMDdmMDJmYzg3OTIyN20AAAAEcm9sZW0AAAAJd2VibWFzdGVybQAAAAp1c2VyX2VtYWlsbQAAABBlbWFpbDFAZW1haWwuY29tbgYAn73iYZkBYgABUYA.b0QFyhTkMdA-jCefqEtoRUZLOYbWL_B5GWxn2FaNNb8"
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat3gnvBsrBmXIABHgj
content-type: application/json; charset=utf-8
{
"token": null,
"status": null,
"roles": null,
"projects": [
{
"title": null,
"saas_project_id": "68cd486184307f02fc879227",
"role": "webmaster"
}
],
"inserted_at": null,
"id": "e4b5ab1ed1a84dbdbeedefd82c1f6117",
"full_name": "Full name",
"email": "[email protected]"
}
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/68cd485584307f02fccdecf5/cancel_invitation
origin: http://c6ac344e-2109-49d1-91df-c1518fcb8ed0.com
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAAVhZG1pbm0AAAAPc2Fhc19wcm9qZWN0X2lkbQAAABg2OGNkNDg1NTg0MzA3ZjAyZmNjZGVjZjVqbQAAAAZzdGF0dXNtAAAACHZlcmlmaWVkbQAAAAd1c2VyX2lkbQAAACA3MmJhMjM1MWJiYTc0YzhkOWU5NzFkZmU3ZjllNWQxZG0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYA2ZbiYZkBYgABUYA.bjFRGFt02str76fqaozudg-srOPgoCN1jnbSRXeMNJg
content-type: multipart/mixed; boundary=plug_conn_test
{
"invitation_user_email": "[email protected]"
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat28WqSt666tQABD-i
content-type: application/json; charset=utf-8
access-control-allow-origin: http://c6ac344e-2109-49d1-91df-c1518fcb8ed0.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 (can be replaced by project domain) | query_string | string | true | ||
| invitation_email | Email to cancel invitation to the project | body | string | true | '[email protected]','[email protected]' |
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/68cd47c584307f02fcae73c8/media
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2M1ODQzMDdmMDJmY2FlNzNjOGptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGJhYTU4MTI4NTFjYTQwNDE4YjQxZWFjMjEzMWVkYjU4bQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBKW-BhmQFiAAFRgA.KNgm6laU3v5oHgZpH3XmetR5FhSJHH2HpxPtePXYjt8
origin: http://c408195a-b59f-4d3f-8ead-af1630b36637.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"type": "image",
"private_status": "public",
"locked_status": "unlocked",
"files": {
"1": {
"file": {
"content_type": "image/png",
"path": "/builds/eweev/geeks/sections/test/support/toggle",
"filename": "-576460752303132125-blue.png"
}
}
}
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatuakCYXWrOAwABHJD
content-type: application/json; charset=utf-8
access-control-allow-origin: http://c408195a-b59f-4d3f-8ead-af1630b36637.com
{
"type": "image",
"title": null,
"tags": null,
"seo_tag": null,
"private_status": "public",
"number_of_contents": 0,
"namespace": "68cd47c584307f02fcae73c8",
"metadata": null,
"meta": {},
"locked_status": "unlocked",
"id": "68cd47c784307f02fccc200f",
"files": [
{
"url": "https://www.fake-url.com/3caa3f3a62e0484c92ef549e5a001ca4",
"type": "image/png",
"thumbnail_url": "https://www.fake-url.com/3e22506f692941eab573093376093060",
"size": 3949,
"platform_id": "64d11a55d7c40100075c27ff",
"metadata": {
"width": 80,
"height": 80
},
"filename": "fake_filename",
"file_id": "fake_file_id"
}
],
"creation_date": "2025-09-19",
"author": "baa5812851ca40418b41eac2131edb58"
}
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 (can be replaced by project domain) | 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/68cd47c584307f02fcae73c8/media/68cd47c784307f02fccc200f
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2M1ODQzMDdmMDJmY2FlNzNjOGptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGJhYTU4MTI4NTFjYTQwNDE4YjQxZWFjMjEzMWVkYjU4bQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBKW-BhmQFiAAFRgA.KNgm6laU3v5oHgZpH3XmetR5FhSJHH2HpxPtePXYjt8
origin: http://c408195a-b59f-4d3f-8ead-af1630b36637.com
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatujOz9kWrOAwABLLB
content-type: application/json; charset=utf-8
access-control-allow-origin: http://c408195a-b59f-4d3f-8ead-af1630b36637.com
{
"type": "image",
"title": null,
"tags": null,
"seo_tag": null,
"private_status": "public",
"number_of_contents": 0,
"namespace": "68cd47c584307f02fcae73c8",
"metadata": null,
"meta": {
"content": [],
"author": "deleted_user"
},
"locked_status": "unlocked",
"id": "68cd47c784307f02fccc200f",
"files": [
{
"url": "https://www.fake-url.com/3caa3f3a62e0484c92ef549e5a001ca4",
"type": "image/png",
"thumbnail_url": "https://www.fake-url.com/3e22506f692941eab573093376093060",
"size": 3949,
"platform_id": "64d11a55d7c40100075c27ff",
"platform": {
"width": 1000,
"updated_at": 1655974869,
"number_of_medias": 0,
"namespace": "sections_app",
"name": "Global Platform",
"inserted_at": 1655974869,
"id": "64d11a55d7c40100075c27ff",
"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": 1758283719,
"author": "baa5812851ca40418b41eac2131edb58"
}
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 (can be replaced by project domain) | 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/68cd47de84307f02fc3bb23d/medias
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2RlODQzMDdmMDJmYzNiYjIzZGptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIDZlNTM2MjI1ZDk0MzQ4MzI4ODIyZGQxY2UxZTQyZGUzbQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgAcveBhmQFiAAFRgA.avYilq5m_f9tcVYijjUOIwMedz2qVbSlrfpWrUejvY4
origin: http://a0628640-b63c-4526-9216-8558514c5746.com
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatv_SY2FEHDBYABN7h
content-type: application/json; charset=utf-8
access-control-allow-origin: http://a0628640-b63c-4526-9216-8558514c5746.com
{
"total": 1,
"result": [
{
"type": "image",
"title": null,
"tags": null,
"seo_tag": null,
"private_status": "public",
"number_of_contents": 0,
"namespace": "68cd47de84307f02fc3bb23d",
"metadata": null,
"meta": {},
"locked_status": "unlocked",
"id": "68cd47e084307f02fcaafaf3",
"files": [
{
"url": "https://www.fake-url.com/2c89650e84624ef3a23f6fb48871a2e0",
"type": "image/png",
"thumbnail_url": "https://www.fake-url.com/1d882d4ff39c4a24a1d82e75a93291b5",
"size": 3949,
"platform_id": "64d11a55d7c40100075c27ff",
"platform": {
"width": 1000,
"updated_at": 1655974869,
"number_of_medias": 0,
"namespace": "sections_app",
"name": "Global Platform",
"inserted_at": 1655974869,
"id": "64d11a55d7c40100075c27ff",
"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": 1758283744,
"author": "6e536225d94348328822dd1ce1e42de3"
}
]
}
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 (can be replaced by project domain) | 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/68cd47c584307f02fcae73c8/media/68cd47c784307f02fccc200f
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAAEbQAAAAVlbWFpbHcDbmlsbQAAAA9zYWFzX3Byb2plY3RfaWRsAAAAAXQAAAACbQAAAARyb2xlbQAAAARVc2VybQAAAA9zYWFzX3Byb2plY3RfaWRtAAAAGDY4Y2Q0N2M1ODQzMDdmMDJmY2FlNzNjOGptAAAABnN0YXR1c20AAAAIdmVyaWZpZWRtAAAAB3VzZXJfaWRtAAAAIGJhYTU4MTI4NTFjYTQwNDE4YjQxZWFjMjEzMWVkYjU4bQAAAAZzdGF0dXNtAAAAB3N1Y2Nlc3NuBgBKW-BhmQFiAAFRgA.KNgm6laU3v5oHgZpH3XmetR5FhSJHH2HpxPtePXYjt8
origin: http://c408195a-b59f-4d3f-8ead-af1630b36637.com
content-type: multipart/mixed; boundary=plug_conn_test
{
"type": "image",
"private_status": "public",
"locked_status": "unlocked",
"files": {
"1": {
"file": {
"content_type": "image/svg",
"path": "/builds/eweev/geeks/sections/test/support/toggle",
"filename": "-576460752303114207-blue.png"
}
}
}
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatuphqqY6rOAwABLhB
content-type: application/json; charset=utf-8
access-control-allow-origin: http://c408195a-b59f-4d3f-8ead-af1630b36637.com
{
"type": "image",
"title": null,
"tags": null,
"seo_tag": null,
"private_status": "public",
"number_of_contents": 0,
"namespace": "68cd47c584307f02fcae73c8",
"metadata": null,
"meta": {},
"locked_status": "unlocked",
"id": "68cd47c784307f02fccc200f",
"files": [
{
"url": "https://www.fake-url.com/e1ef6743652441a684841ae1990e336b",
"type": "image/svg",
"thumbnail_url": "https://www.fake-url.com/3175bac76bf64a8c882c27935541985e",
"size": 3949,
"platform_id": "64d11a55d7c40100075c27ff",
"metadata": {
"width": 80,
"height": 80
},
"filename": "fake_filename",
"file_id": "fake_file_id"
}
],
"creation_date": "2025-09-19",
"author": "baa5812851ca40418b41eac2131edb58"
}
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 (can be replaced by project domain) | 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/68cd47c684307f02fc347ee3
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACBhM2Q0MjkwNDk2Yjk0OWExYjVkM2Q3Y2E0YTQyNjRmMm0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAUV3gYZkBYgABUYA.AiGhXHT4pi15GF2uRHmkoxs407JcggHwrJ2o1V_ujFE
pkey: $2b$12$si9g2aVcTkqT8tFHF/DTuetrW6cUrLahZ1mfCEhRYojrQsrQeUjLW
content-type: multipart/mixed; boundary=plug_conn_test
{
"title": "New title 123"
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatue0R_QY5jr0ABHXD
content-type: application/json; charset=utf-8
{
"type": "private",
"title": "New title 123",
"section_types_count": null,
"reason": null,
"project_url": [
"http://localhost:3000",
"f4397c84-993a-489c-bb16-43f23c904eca.com"
],
"private_packages": null,
"private_key": "$2b$12$qeF4iGYVlojOVWe9TAhu2e1kHmEellSMHAnkK8QWr.IwbefMPQdFm",
"pages_count": null,
"package_label": null,
"package": "free",
"metadata": {},
"login_redirect_url": "http://localhost:3000/redirect-login",
"limits": null,
"limitation_status": "active",
"last_req_date": null,
"inserted_at": 1758283718,
"id": "68cd47c684307f02fc347ee3",
"files_counter": 0,
"configured_fields": {},
"billing_status": "upgrade_lock",
"active": true
}
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/68cd47d884307f02fcbf51c8/reset_key
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACAzODhmMWJmNjY4OWI0MjkyYmI3NzZiZTUzM2I4YTFiYW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAa6PgYZkBYgABUYA.aCCeiOaQwdSq13IspM0nQRv_RPBzoCzN28xLW4rb4O0
pkey: $2b$12$IGHvzAACWI7QSl52noUehuwxjc9Gl2jFa7en9cVoLPAhSS1nFQH1u
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatvhiYO0pB2Y0ABDZi
content-type: application/json; charset=utf-8
{
"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/68cd47d784307f02fce55002/dashboard
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACA0MjU4OTI5ODMwYzU0MWFlYmRmNTNhMTUwNTFkOTViOW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAjp_gYZkBYgABUYA.4h_JoI8sey4-ScNdjgBrK_PPhojWv__dRw4GtlnirMg
pkey: $2b$12$DN2SQYQDluXJ1Hd4Hhh3yuOP1uLjA0ZUHYnpj9kNxcPoJoPwm481a
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatveE12sym8DMABDYC
content-type: application/json; charset=utf-8
{
"package_name": "free",
"package_locked": false,
"package_label": "Free",
"max_pages": 2,
"max_media_files": 10,
"max_file_size": 500000,
"current_pages": 0,
"current_medias": 0,
"api_until_reset": 42664086,
"api_limit_use": {
"value": 500,
"unit_price": 1,
"name": "api_limit_day",
"included": 1
},
"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 |
Indicates if usages fit a package
When a project wants to update a package it compares offline mode/projected usage to all packages
POST /api/v1/project/68cd47c784307f02fccc2010/projected_usage/all
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACBkOGU0ZjNlYjY5OWM0ZWQzYTllNzIwMjUyOGIwMTMwNG0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAxmLgYZkBYgABUYA.95pvrDegHRVIWWhcOy6Zd-8r7ONQTYjNzQZ7pgrjCU4
pkey: $2b$12$0eyGfjrn9PQVVqU847oAFexfJSVq/i1Ms.j2denDCdruQrOqySHye
content-type: multipart/mixed; boundary=plug_conn_test
{
"usages": {
"users_count": 1,
"top_sections_in_page_count": 6,
"top_page_variations_count": 1,
"top_file_size": 24000,
"section_type_count": 6,
"require_qs": true,
"require_dynamic_sections": true,
"pages_count": 5,
"files_count": 24,
"domains_count": 1
}
}
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatuqAfu65nJIQABAgi
content-type: application/json; charset=utf-8
[
{
"status": "success",
"package": {
"usage": null,
"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": "68cd47c184307f02fc110d2a"
},
"message": "Package supports projected usage"
},
{
"status": "failed",
"package": {
"usage": null,
"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,
"unit_price": 1,
"name": "api_limit_day",
"included": 1
},
{
"value": 0,
"name": "dynamic_section_types_support"
},
{
"value": 1,
"name": "users"
},
{
"value": 2,
"name": "domains"
}
],
"label": "Free",
"id": "68cd47c184307f02fc110d28"
},
"message": {
"top_sections_in_page_count": [
"Exceeds package limit of 5"
],
"section_type_count": [
"Exceeds package limit of 5"
],
"require_qs": [
"Not enabled in package"
],
"require_dynamic_sections": [
"Not enabled in package"
],
"pages_count": [
"Exceeds package limit of 2"
],
"files_count": [
"Exceeds package limit of 10"
]
}
},
{
"status": "failed",
"package": {
"usage": null,
"type": "public",
"rank": 1,
"quota": 1,
"price": 0,
"name": "quota_1",
"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": -1,
"name": "api_limit_hour"
},
{
"value": -1,
"name": "api_limit_minute"
},
{
"value": 500,
"name": "api_limit_day"
},
{
"value": 0,
"name": "dynamic_section_types_support"
},
{
"value": 1,
"name": "users"
},
{
"value": 1,
"name": "domains"
}
],
"label": "quota_1_label",
"id": "68cd47c784307f02fccc200e"
},
"message": {
"top_sections_in_page_count": [
"Exceeds package limit of 5"
],
"require_dynamic_sections": [
"Not enabled in package"
],
"pages_count": [
"Exceeds package limit of 2"
],
"files_count": [
"Exceeds package limit of 10"
]
}
},
{
"status": "failed",
"package": {
"usage": null,
"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,
"unit_size": 100,
"unit_price": 2,
"name": "api_limit_day",
"included": 5
},
{
"value": 0,
"name": "dynamic_section_types_support"
},
{
"value": 2,
"name": "users"
},
{
"value": 1,
"name": "domains"
}
],
"label": "Standard",
"id": "68cd47c184307f02fc110d29"
},
"message": {
"require_qs": [
"Not enabled in package"
],
"require_dynamic_sections": [
"Not enabled in package"
]
}
}
]
Checks if the projected usages given in the body will fit the selected package.
Can also check it against all available packages at once by giving the all value as the package name.
If no usages are provided it will check all packages against your project's usages.
Request
POST api/v1/project/:project_id/projected_usage
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 | |
| usages | A projected usages object, all fields must be provided | body | map | true | {"users_count":1,"top_sections_in_page_count":5,"top_page_variations_count":0,"top_file_size":42500,"section_type_count":3,"require_qs":false,"require_dynamic_sections":true,"pages_count":1,"files_count":6,"domains_count":1} | |
| package | The name of an existing package, or all |
query_string | string | true |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Project Resource | Project |
| 404 | Error Resource | Error |
| 422 | Error Resource | Error |
Returns the current usage of a project
When a project wants to update a package returns the current usage of a project
GET /api/v1/project/68cd47d484307f02fcfcaebb/current_usage
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACA2NWJjM2I0YjAyN2E0NmIwYTc1MmQ5MDM2NjJmMTQ1N20AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAgZXgYZkBYgABUYA.2PyRi3HwsllpQtfooCdN8FqYi7s5QdUIs2IxwcJEopw
pkey: $2b$12$MH0TBG30tGuM5cLxbq5QGOwNEJPhvd6ea9bJWk6vLS5i.mHTelEwm
Response
200
cache-control: max-age=0, private, must-revalidate
x-request-id: GGatvaRwNYCTDP4ABDRi
content-type: application/json; charset=utf-8
{
"users_count": 1,
"top_sections_in_page_count": 0,
"top_page_variations_count": 0,
"top_file_size": 0,
"section_type_count": 0,
"require_qs": false,
"require_dynamic_sections": false,
"pages_count": 0,
"files_count": 0,
"domains_count": 1
}
Returns the current usage of a project
Request
POST api/v1/project/:project_id/current_usage
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 | Usage Resource | Project |
| 404 | Error Resource | Error |
| 422 | 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.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACBlNDA2MWU4OGMwYzM0ODk2YTEwNDdkZTI3YmE0MjgwNG0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAOmziYZkBYgABUYA._VKSBfDRPvwC0ItjHVUNzP-3CgqDcLx4INU_Rd-Nbn4
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat2Wz3JBmu-3IABOth
access-control-allow-origin: http://clientapp.com:3001
{
"total": 79,
"public_packages": [
{
"value": "Free",
"key": "free"
},
{
"value": "Standard",
"key": "solo"
},
{
"value": "Corporate",
"key": "corporate"
},
{
"value": "quota_1_label",
"key": "quota_1"
},
{
"value": "QS_enabled",
"key": "qs_enabled"
}
],
"data": [
{
"type": "private",
"title": "some title",
"section_types_count": 0,
"reason": null,
"project_url": [
"e4523c43-7216-47b6-b84d-50e56acce85a.com"
],
"private_packages": [],
"private_key": "**REDACTED**",
"pages_count": 0,
"package_label": "Free",
"package": "free",
"metadata": {},
"login_redirect_url": null,
"limits": {
"reset_time": 42545917,
"package": 500,
"consumption": 0
},
"limitation_status": "active",
"last_req_date": null,
"inserted_at": 1758283714,
"id": "68cd47c284307f02fce2e45f",
"files_counter": 0,
"configured_fields": {},
"billing_status": "upgrade_lock",
"active": true
}
]
}
Used to retrieve list of projects. Current supported filters are:
earliest_last_req_date: Timestamp of last_req_date as the earliest, ex:
1758283706latest_last_req_date: Timestamp of last_req_date as the latest, ex:
1758283706package: 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: `[email protected]
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.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACBhMzMyYThjMDg0MjI0ZGQ2OWVmMzZiMjcyYzZiNmMyMm0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAEK3jYZkBYgABUYA.bezCbgrbAVGV8cFQAWasomNrPwTVNHHuFktTNmIe9-U
origin: http://b09d9e1d-8c6d-4ab8-ab7f-332d268365c3.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: GGat7Hjy4MtUDqYABFBi
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/68cd48a084307f02fc5466d7
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACA3YWZiMThmMjcwMzM0Y2NkOGI3OGJkZDY0ODQ3NWRhMm0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYA3K_jYZkBYgABUYA.yNT3XzJ_4DPpOJAqO_9F0qBQXWhZm9w-dFwQbIkJ4qY
origin: http://7f093c66-5fa0-4351-a6bd-d466eb1bfdb1.com
Response
200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: GGat7KJmYJI6hvwABFCC
access-control-allow-origin: http://clientapp.com:3001
{
"usage": null,
"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": "68cd48a084307f02fc5466d7"
}
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/68cd48a984307f02fc92dffb
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACA1MTlkNDMxZWJhNmI0ZmExOTc1ZGQ3MzgxNWE4OTE4OW0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYAstLjYZkBYgABUYA.T3D5gk-X48rigmoa0XqA6cOMvwJPbhDvQctZypXJUxI
origin: http://84f15265-9020-4fde-bc82-2aced83dcdcf.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: GGat7rRIWgi2W0cABQhh
access-control-allow-origin: http://clientapp.com:3001
{
"usage": null,
"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": "68cd48a984307f02fc92dffb"
}
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/68cd48a684307f02fc94b182/duplicate
token: SFMyNTY.g2gDdAAAAAJtAAAABGRhdGF0AAAAAW0AAAAEdXNlcnQAAAACbQAAAAxyb2xlc19vYmplY3RsAAAAAXQAAAABbQAAAAV0aXRsZW0AAAALc3VwZXJfYWRtaW5qbQAAAAd1c2VyX2lkbQAAACBlYzU2ZDIzZjE0ZDM0MzM1ODRhNjdiODgxZDI5ZGQxZm0AAAAGc3RhdHVzbQAAAAdzdWNjZXNzbgYATcfjYZkBYgABUYA.bHpb4xqUrSueqH5k0I7VjE9RKZerABuNNwLGVnxXaWg
origin: http://9e9c4f19-f6e1-482a-8fbd-0b79237f1c34.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: GGat7gaxopwPwRkABFKC
access-control-allow-origin: http://clientapp.com:3001
{
"usage": null,
"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": "68cd48a684307f02fc94b183"
}
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 |