Khởi động nhanh

Rất vui được biết: Hướng dẫn khởi động nhanh có thể tốt để giúp mọi người đứng dậy và chạy với API của bạn trong vài bước. Một số người thích lặn với những điều cơ bản hơn là đọc kỹ từng trang tài liệu!

Nhận các phím API của bạn

Các yêu cầu API của bạn được xác thực bằng cách sử dụng các khóa API. Bất kỳ yêu cầu nào không bao gồm khóa API sẽ trả về lỗi. Bạn có thể tạo khóa API từ Bảng điều khiển của mình bất cứ lúc nào.

Cài đặt thư viện

Cách tốt nhất để tương tác với API là sử dụng một trong các thư viện chính thức của chúng tôi:

Node

# Install via NPM
npm install --save my-api

Python

# Install via pip
pip install --upgrade myapi

Rất vui được biết: Dùng các thẻ để phân tách các ngôn ngữ khác nhau là một cách tuyệt vời để trình bày các ví dụ kỹ thuật hoặc tài liệu mã hóa mà không nhồi nhét thêm phần hay trang cho mỗi ngôn ngữ vào tài liệu của bạn.

Hãy đưa ra yêu cầu đầu tiên của bạn

Để đưa ra yêu cầu đầu tiên của bạn, hãy gửi yêu cầu xác thực đến điểm cuối của vật nuôi. Cái này sẽ tạo ra một con thú cưng, thật tuyệt.

Create pet.

POST https://api.myapi.com/v1/pet

Creates a new pet.

Request Body

Name	Type	Description
name*	string	The name of the pet
owner_id	string	The id of the user who owns the pet
species	string	The species of the pet
breed	string	The breed of the pet

200 Pet successfully created

{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}

401 Permission denied

Rất vui được biết: Bạn có thể sử dụng khối Phương pháp API để làm tài liệu đầy đủ phương pháp API. Bạn cũng có thể đồng bộ hóa các khối API của mình với MởTệp API hoặc URL để tự động điền chúng.

Hãy xem làm thế nào bạn có thể gọi phương pháp này bằng thư viện chính thức của chúng tôi, hoặc thông quacurl:

curl

curl https://api.myapi.com/v1/pet  
    -u YOUR_API_KEY:  
    -d name='Wilson'  
    -d species='dog'  
    -d owner_id='sha7891bikojbkreuy'  

Node

// require the myapi module and set it up with your API key
const myapi = require('myapi')(YOUR_API_KEY);

const newPet = away myapi.pet.create({
    name: 'Wilson',
    owner_id: 'sha7891bikojbkreuy',
    species: 'Dog',
    breed: 'Golden Retriever',
})

Python

// Set your API key before making the request
myapi.api_key = YOUR_API_KEY

myapi.Pet.create(
    name='Wilson',
    owner_id='sha7891bikojbkreuy',
    species='Dog',
    breed='Golden Retriever',
)