Create (POST)

Use the POST method to store data.

Content types supported are "text/plain" or "application/json" - You can send plain text to the server or JSON. We recommend using “application/json” but also give the option of “text/plain” requests to give developers more freedom.

uniqueId - For each request we generate an uniqueId to identify the record stored in the database. This id can be used for the other request types.

note

Please remember that you are responsible for the data stored in your endpoints. YAWE's only objective is to provide a service to its users to make their life easier, we don't have interest in the data and we don't monitor it.

Request data#

HTTP method: POST

URL format: https://baseUrl/versionNumber/customEndpointRoute/userEndpoint?key=apiKey[&dataOnly=true]

Example: https://app.yawe.dev/api/1/ce/examples/unsecure-endpoint?key=d59eb2859c284168ac48aef65046d5dd[&dataOnly=true]

Request Cookies#

HeaderDescriptionRequired
yawe_access_tokenThe Access token is required for secure endpoints.

It is obtained when doing a login. To automatically include it in the request you need to set the following property:

// using fetch
{ credentials: 'include' }
// using axios
{ withCredentials: true }

For more information check Secure Endpoints.

No

Request Headers#

HeaderDescriptionRequired
Content-TypeSpecifies the MIME type of the body of the Request. It may be:
  • application/json
  • text/plain
Yes

Request Parameters#

The following table describes the Request parameters.

ParameterDescriptionRequired
baseUrlBase url for calling the API.

Value: app.yawe.dev/api

Yes
versionNumberService version.

Value: The current value is 1.

Yes
customEndpointRouteThe route which identifies custom endpoints.

Default value: ce

Yes
userEndpointThe endpoint name generated by the user.

Value: the name created at https://app.yawe.dev

Yes
keyThe API Key of the project.Yes
dataOnlyIf used, the endpoint response will be the POST body, without additional information such as ‘uniqueId’.

Value: true

No
masterKeyOverrides the need for Access tokens or restrictions applied to Authentication endpoints.

Don't use this key in your client application.

For more information please refer to projects.

Value: the masterKey created at https://app.yawe.dev.

No

POST body#

You can post JSON or plain text, just make sure you set the appropriate Content-Type header.

Response data#

Error codes#

Error codeDescription
400Possible reasons:
  • Endpoint or API Key not valid.
  • Wrong Content-Type, it only accepts "text/plain" or "application/json".
  • Empty Request body.
401If the endpoint is secured and the access token is missing or is not valid.

It may also return this error if the user no longer exists.

403Missing API Key, not allowed origin or disallowed request without orign.

Successful response#

{
uniqueId: "3f38bf9e1bb54d2396d1f1b8fbba1630",
data: { property: "data" },
createdAt: "2020-12-27T10:58:45.000Z",
updatedAt: "2020-12-27T10:58:45.000Z"
}