# 欢迎使用米发开发者文档!

## 介绍

米发的  API 是按照 REST 架构组织的。我们的 API 采用可预测的面向资源的 URL，返回 JSON 编码响应，并使用标准的 HTTP 响应代码、身份验证和动词。

## 想快速进入开发？

Feeling like an eager beaver? Jump in to the quick start docs and get making your first request:

{% content-ref url="/pages/rLm4eOvqUtI6RJxr7nOh" %}
[快速开始](/kuai-su-kai-shi)
{% endcontent-ref %}

## 想要更深层次的了解？

深入了解并开始探索我们的API参考文档，以了解API所能实现的所有功能：

{% content-ref url="/pages/1nznbr75AMlmoFplpZaV" %}
[Broken mention](broken://pages/1nznbr75AMlmoFplpZaV)
{% endcontent-ref %}


# 快速开始

{% hint style="info" %}
**知道吗**：快速启动指南可以帮助人们在几个步骤中轻松上手你的API。有些人更喜欢从基础开始学习，而不是详细阅读每一页的文档！
{% endhint %}

## 获取 API 密钥

米发的 API 使用 API 密钥和 API 密钥验证请求。要开始使用，您必须首先通过登录您的米发仪表板创建 API 密钥。 您的 API 密钥具有许多特权，因此请务必保持安全！不要在公共可访问区域（如 GitHub、客户端代码等）共享您的秘密 API 密钥。 米发的 API 要求在任何请求中设置 Authorization 请求头。标题的语法如下：Authorization: bearer 。令牌是一个字符串，您可以在米发控制台中生成。

## 测试密钥

可以使用命令行测试你的密钥是否成功创建

{% tabs %}
{% tab title="curl" %}

```
curl --location --request GET 'https://api.mfpad.com/v1/test' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {your-token-here}'
```

{% endtab %}
{% endtabs %}


# API 参考


# 账户

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/account" method="get" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}


# 域名

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/host" method="get" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}


# 短链接

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/link" method="get" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/link" method="post" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/link/{id}" method="get" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/link/{id}" method="put" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/link/{id}" method="delete" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}


# 重定向

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/redirect" method="get" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/redirect" method="post" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/redirect/{id}" method="get" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/redirect/{id}" method="put" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/redirect/{id}" method="delete" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}


# 工作区

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/workspace" method="get" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}


# 订阅

{% openapi src="/files/V239VHeuOrdV8ILm9EuR" path="/workspace/subscription" method="get" %}
[public (1).json](https://3489775420-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUp0B1mAFC15IsdJqdsBH%2Fuploads%2FjGHwdntZiBsEYZiDfPQs%2Fpublic%20\(1\).json?alt=media)
{% endopenapi %}