4 Commits

Author SHA1 Message Date
cb351f8199 1.0.29 2019-08-12 13:16:28 +02:00
8178420263 fix(core): update 2019-08-12 13:16:28 +02:00
9d3c283859 1.0.28 2019-08-12 12:37:39 +02:00
2f88e7e1d1 fix(core): update 2019-08-12 12:37:39 +02:00
8 changed files with 46 additions and 17 deletions

View File

@ -1,8 +1,19 @@
# Bellini.io Documentation # Getting started with api.global
headless Open Source CMS
!!! info
Use the search box for quickly finding what you are looking for.
## What is this? ## What is this?
bellini.io enables easy maintance of content for large scale commercial websites. api.global is the high availability api endpoint for all products created by [lossless](https://lossless.com).
!!! hint
Most products offer TypeScript packages on npm that simplify interaction with the API for the product specific use case. As of now those are:
* [@layer.io/api](https://npmjs.org/layer.io/api)
* [@social.io/api](https://npmjs.org/layer.io/api)
* [@onboardme/api](https://npmjs.org/layer.io/api)
* [@inwork/api](https://npmjs.org/layer.io/api)
## What does this documentation cover? ## What does this documentation cover?
This documentation explains how to interface with bellini.io and how to use its APIs This documentation explains how to structure api calls to api.global and to be aware of the mechanics of load distribution.
We strongly recommend checking out our npm package that implements the hard stuff for you.

15
markdown/limitations.md Normal file
View File

@ -0,0 +1,15 @@
# Limitations
api.global is deplyoing a few hard limitations on a per account basis:
* 1 million API requests per hour
* 12 million API requests per day
!!! hint
running into one of those limitations will result in a 429 status code with an info of when to try again attached as json payload in the response.
```json
{
"retryIn": 3600000
}
```

3
markdown/nodejs.md Normal file
View File

@ -0,0 +1,3 @@
# NodeJS SDK
api.global offers a nodejs sdk that makes it easy to implement api.global features into your own software

View File

@ -1,4 +0,0 @@
---
name: NodeJS SDK
---
bellini.io offers a TypeScript package which is the recommended way of interfacing with bellini.io

3
markdown/support.md Normal file
View File

@ -0,0 +1,3 @@
# Support
api.global is covered by Lossless Support. To see available support packages visit https://lossless.support

View File

@ -1,5 +1,5 @@
# Project information # Project information
site_name: api.global - high availability API site_name: api.global - documentation
site_description: high availability API made by lossless site_description: high availability API made by lossless
site_author: Lossless GmbH site_author: Lossless GmbH
site_url: https://docs.api.global/ site_url: https://docs.api.global/
@ -10,8 +10,8 @@ site_dir: public
# Repository # Repository
repo_name: apiglobal/docs repo_name: apiglobal/docs
repo_url: https://gitlab.com/apiglobal/docs repo_url:
edit_uri: "https://gitlab.com/apiglobal/docs/edit/master/markdown/" edit_uri: ""
# Copyright # Copyright
copyright: 'Copyright © 2016 - 2019 Lossless GmbH' copyright: 'Copyright © 2016 - 2019 Lossless GmbH'
@ -86,7 +86,8 @@ markdown_extensions:
# Page tree # Page tree
nav: nav:
- Getting Started: index.md - Overview:
- API: - Getting Started: index.md
- REST: api.md - Limitations: limitations.md
- NodeJS: sdks/nodejs.md - NodeJS: nodejs.md
- Support: support.md

2
package-lock.json generated
View File

@ -1,6 +1,6 @@
{ {
"name": "awpm.xyz", "name": "awpm.xyz",
"version": "1.0.27", "version": "1.0.29",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
"dependencies": { "dependencies": {

View File

@ -1,6 +1,6 @@
{ {
"name": "awpm.xyz", "name": "awpm.xyz",
"version": "1.0.27", "version": "1.0.29",
"description": "the specification for the awesome workplace manifesto", "description": "the specification for the awesome workplace manifesto",
"main": "dist/index.js", "main": "dist/index.js",
"scripts": { "scripts": {