Skip to content

Commit

Permalink
Добавлена более подробная документация sdelements#1
Browse files Browse the repository at this point in the history
  • Loading branch information
Artem Anashev committed May 5, 2017
1 parent 84303f0 commit 7a1327a
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 82 deletions.
26 changes: 10 additions & 16 deletions source/includes/_errors.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# Errors
# Ошибки

<aside class="notice">This error section is stored in a separate file in `includes/_errors.md`. Slate allows you to optionally separate out your docs into many files...just save them to the `includes` folder and add them to the top of your `index.md`'s frontmatter. Files are included in the order listed.</aside>
> Статусы ошибок
The Kittn API uses the following error codes:
> Код ошибки | Значение | Описание |
> ---------- | -------- | -------- |
> 400 | Ошибка валидации банковской карты | |
> 401 | Ошибка аудентификации | |
> 402 | Ошибка подключения к API Яндекс.Кассы | |
<aside class="notice">This error section is stored in a separate file in `includes/_errors.md`. Slate allows you to optionally separate out your docs into many files...just save them to the `includes` folder and add them to the top of your `index.md`'s frontmatter. Files are included in the order listed.</aside>

Error Code | Meaning
---------- | -------
400 | Bad Request -- Your request sucks
401 | Unauthorized -- Your API key is wrong
403 | Forbidden -- The kitten requested is hidden for administrators only
404 | Not Found -- The specified kitten could not be found
405 | Method Not Allowed -- You tried to access a kitten with an invalid method
406 | Not Acceptable -- You requested a format that isn't json
410 | Gone -- The kitten requested has been removed from our servers
418 | I'm a teapot
429 | Too Many Requests -- You're requesting too many kittens! Slow down!
500 | Internal Server Error -- We had a problem with our server. Try again later.
503 | Service Unavailable -- We're temporarially offline for maintanance. Please try again later.
CheckoutJs поддерживает ошибки привычных HTTP запросов. Все коды, начинающиеся с `20*` сигнализируют об успешном платеже,
`40*` о том, что что-то пошло не так.
85 changes: 19 additions & 66 deletions source/includes/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,86 +17,39 @@
Чтобы подключить ее, нужно подключить скрипт из CDN, после этого в глобальной области видимости библиотека будет доступна
под именем **CheckoutJs**

# Создания токена

## Get All Kittens

```javascript
const kittn = require('kittn');
# Аудентификация

let api = kittn.authorize('meowmeowmeow');
let kittens = api.kittens.get();
```js
const checkoutJs = CheckoutJs(123456);
```

> The above command returns JSON structured like this:
```json
[
{
"id": 1,
"name": "Fluffums",
"breed": "calico",
"fluffiness": 6,
"cuteness": 7
},
{
"id": 2,
"name": "Max",
"breed": "unknown",
"fluffiness": 5,
"cuteness": 10
}
]
```

This endpoint retrieves all kittens.

### HTTP Request
> Где **123456** ваш секретный токен
`GET http://example.com/api/kittens`
Чтобы создать токен, вы должны авторизоваться к личном кабинете [Яндекс.Касса](https://ya.ru). После этого перейти в раздел
создания токена для вашего магазина. Не в коем случае не выставляйте ваш секретный токен на ружу! Это приватная информация, ни кто
не должен о нем знать кроме вас.

### Query Parameters
После этого вы можете создать инстанс от CheckoutJs и использовать **checkoutJs** для генерации токена по данным банковской карты.

Parameter | Default | Description
--------- | ------- | -----------
include_cats | false | If set to true, the result will also include cats.
available | true | If set to false, the result will include kittens that have already been adopted.

<aside class="success">
Remember — a happy kitten is an authenticated kitten!
</aside>

## Get a Specific Kitten
# Конфигурация

```javascript
const kittn = require('kittn');

let api = kittn.authorize('meowmeowmeow');
let max = api.kittens.get(2);
```js
const checkoutJs = CheckoutJs(123456, {
language: 'en'
});
```

> The above command returns JSON structured like this:
Также вы можете передать второй аргумент, который будет отвечать за конфигурацию.

> Возможные значения:
```json
```js
{
"id": 2,
"name": "Max",
"breed": "unknown",
"fluffiness": 5,
"cuteness": 10
// язык вывода ответов
language: string ('en' | 'ru') ['ru']
}
```

This endpoint retrieves a specific kitten.

<aside class="warning">Inside HTML code blocks like this one, you can't use Markdown, so use <code>&lt;code&gt;</code> blocks to denote code.</aside>

### HTTP Request

`GET http://example.com/kittens/<ID>`

### URL Parameters

Parameter | Description
--------- | -----------
ID | The ID of the kitten to retrieve
17 changes: 17 additions & 0 deletions source/stylesheets/screen.css.scss
Original file line number Diff line number Diff line change
Expand Up @@ -561,6 +561,23 @@ html, body {
border-top: 1px solid #000;
border-bottom: 1px solid #404040;
}

table {
margin-top: 20px;
width: 100%;

tr:last-child {
border-bottom: 1px solid #ccc;
}

tr:nth-child(odd)>td {
background-color: $code-bg;
}

tr:nth-child(even)>td {
background-color: $code-annotation-bg;
}
}
}
}

Expand Down

0 comments on commit 7a1327a

Please sign in to comment.