WordPress REST API 常用接口示例

0、前言

本文主要是针对使用WordPress作为后端的教程讲解,列举了常用的请求接口,并举了一些通俗易懂的例子。

具体的WordPress REST API文档本站已经机翻了一小部分,感兴趣者可以移步 WordPress REST API手册(一):REST API 手册

注:
1、以下接口拼接自己的域名,如:https://www.hejianchao.club。
2、在WordPress REST API 文档中,有些接口没有提供,建站时需要后台服务器帮助提供,以下我这边是自己后台服务器提供接口用米字号作*标记。
3、以下接口get请求一般请求头可以不带token。
4、wp的token有效期为24小时,过期就要重新进行请求。

1、登录注册模块

1.1、用户注册 *

请求协议|请求方法:HTTP|POST
接口路径:/fapi/userregster.php
请求参数

参数名说明类型
username用户名,必填[string]
password密码,必填[string]
email邮箱[string]
nickname昵称[string]
phone手机号[string]
用户注册请求参数

返回结果:直接返回新用户id。

1.2、获取Token

请求协议|请求方法:HTTP|POST
接口路径:/wp-json/jwt-auth/v1/token
请求参数

参数类型:表单

参数名说明必填类型
username用户名[string]
password密码[string]
获取Token请求参数

成功示例:

{
    "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC96aG91YnV5aS5tZWlsYXNoaWRhaS5jbiIsImlhdCI6MTU4Njc2NDA3MCwibmJmIjoxNTg2NzY0MDcwLCJleHAiOjE1ODczNjg4NzAsImRhdGEiOnsidXNlciI6eyJpZCI6IjIyIn19fQ.7kgtWfUTlm6tbZX63V7OEpo08PAxakZiK4e9DE6Nvb8",
    "user_email":"",
    "user_nicename":"100022",
    "user_display_name":"1111111"
}

1.3、验证Token

请求协议|请求方法:HTTP|POST

接口路径:/wp-json/jwt-auth/v1/token/validate
请求头部

头部标签必填头部内容
AuthorizationBearer+token
验证Token头部信息

成功示例:

{
    "code":"jwt_auth_valid_token",
    "data":{
        "status":200
    }
}

注意点1: 获取的token要放在请求头,并且token值的格式必须为:Bearer+token值,否侧无法判断。

例如:BearereyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC96aG91YnV5aS5tZWlsYXNoaWRhaS5jbiIsImlhdCI6MTU4Njc2NDA3MCwibmJmIjoxNTg2NzY0MDcwLCJleHAiOjE1ODczNjg4NzAsImRhdGEiOnsidXNlciI6eyJpZCI6IjIyIn19fQ.7kgtWfUTlm6tbZX63V7OEpo08PAxakZiK4e9DE6Nvb8

注意点2: 要实现这个接口,需要后台服务器授权验证,详细参考:使用 JWT Authentication 验证 WordPress REST API 权限,只有授权验证处理通过,这个接口才能请求成功,否则会返回错误,要求授权。

1.4、账户登录 *

请求协议|请求方法:HTTP|POST

接口路径:/fapi/loginwithtoken.php

请求头部

头部标签必填头部内容
AuthorizationBearer+token
请求头部信息

请求参数

参数名说明必填类型
username用户名[string]
pwd密码[string]
账户登录参数

成功示例

{
    "data":{
        "ID":"22",
        "user_login":"1111111",
        "user_pass":"$P$BSz.lD0LqQxK/v8E9Un1Cc3VwnURpp.",
        "user_nicename":"100022",
        "user_email":"wyp001@1234.com",
        "user_url":"",
        "user_registered":"2020-04-13 07:23:02",
        "user_activation_key":"",
        "user_status":"0",
        "display_name":"1111111",
        "father_id":"0",
        "reg_ip":""
    },
    "ID":22,
    "caps":{
        "author":true
    },
    "cap_key":"wp_capabilities",
    "roles":[
        "author"
    ],
    "allcaps":{
        "upload_files":true,
        "edit_posts":true,
        "edit_published_posts":true,
        "publish_posts":true,
        "read":true,
        "level_2":true,
        "level_1":true,
        "level_0":true,
        "delete_posts":true,
        "delete_published_posts":true,
        "author":true
    },
    "filter":null
}

1.5、获取用户信息

请求协议|请求方法:HTTP|GET

接口路径:/wp-json/wp/v2/users/me

请求头部

头部标签必填头部内容
Authorization用户token,格式:Bearer+token
获取用户信息参数

成功示例

{
    "id":22,
    "name":"1111111",
    "url":"",
    "description":"描述啊描述",
    "link":"https://www.hejianchao.club/author/100022/",
    "slug":"100022",
    "avatar_urls":{
        "24":"http://cn.gravatar.com/avatar/cf29dfa8761d26cf525bd3275293a527?s=24&d=mm&r=g",
        "48":"http://cn.gravatar.com/avatar/cf29dfa8761d26cf525bd3275293a527?s=48&d=mm&r=g",
        "96":"http://cn.gravatar.com/avatar/cf29dfa8761d26cf525bd3275293a527?s=96&d=mm&r=g"
    },
    "meta":[

    ],
    "woocommerce_meta":{
        "activity_panel_inbox_last_read":"",
        "activity_panel_reviews_last_read":"",
        "categories_report_columns":"",
        "coupons_report_columns":"",
        "customers_report_columns":"",
        "orders_report_columns":"",
        "products_report_columns":"",
        "revenue_report_columns":"",
        "taxes_report_columns":"",
        "variations_report_columns":"",
        "dashboard_sections":"",
        "dashboard_chart_type":"",
        "dashboard_chart_interval":"",
        "dashboard_leaderboard_rows":""
    },
    "_links":{
        "self":[
            {
                "href":"https://www.hejianchao.club/wp-json/wp/v2/users/22"
            }
        ],
        "collection":[
            {
                "href":"https://www.hejianchao.club/wp-json/wp/v2/users"
            }
        ]
    }
}

1.6、修改用户信息

wpAPI中没有找到该接口,是根据获取用户信息get方法,推理出来,修改用户信息为post,测试部分字段有效,以下请求参数列表,是个人认为会有用到,才罗列出来的。
请求协议|请求方法:HTTP|POST
接口路径:/wp-json/wp/v2/users/me
请求头部

头部标签必填头部内容
AuthorizationBearer+token
请求头部信息

请求参数

参数名说明必填类型
name显示名称[string]
first_name名字[string]
last_name姓氏[string]
email邮箱[string]
locale语言设置,默认:zh_CN[string]
nickname昵称[string]
roles如:[ “author” ][array]
capabilities功能分类设置,查看返回结果[string]
avatar_urls头像,如:{ “24”:“http://cn.gravatar.com/avatar/cf29dfa8761d26cf525bd3275293a527?s=24&d=mm&r=g”, “48”:“http://cn.gravatar.com/avatar/cf29dfa8761d26cf525bd3275293a527?s=48&d=mm&r=g”, “96”:“http://cn.gravatar.com/avatar/cf29dfa8761d26cf525bd3275293a527?s=96&d=mm&r=g” }。[object]
woocommerce_meta店铺的相关配置[string]
修改用户信息参数

成功示例

{
    "id":22,
    "username":"1111111",
    "name":"测试将name1111111修改ceshi",
    "first_name":"",
    "last_name":"",
    "email":"wyp001@123.com",
    "url":"",
    "description":"描述啊描述",
    "link":"https://www.hejianchao.club/author/100022/",
    "locale":"zh_CN",
    "nickname":"1111111",
    "slug":"100022",
    "roles":[
        "author"
    ],
    "registered_date":"2020-04-13T07:23:02+00:00",
    "capabilities":{
        "upload_files":true,
        "edit_posts":true,
        "edit_published_posts":true,
        "publish_posts":true,
        "read":true,
        "level_2":true,
        "level_1":true,
        "level_0":true,
        "delete_posts":true,
        "delete_published_posts":true,
        "author":true
    },
    "extra_capabilities":{
        "author":true
    },
    "avatar_urls":{
        "24":"http://cn.gravatar.com/avatar/cf29dfa8761d26cf525bd3275293a527?s=24&d=mm&r=g",
        "48":"http://cn.gravatar.com/avatar/cf29dfa8761d26cf525bd3275293a527?s=48&d=mm&r=g",
        "96":"http://cn.gravatar.com/avatar/cf29dfa8761d26cf525bd3275293a527?s=96&d=mm&r=g"
    },
    "meta":[

    ],
    "woocommerce_meta":{
        "activity_panel_inbox_last_read":"",
        "activity_panel_reviews_last_read":"",
        "categories_report_columns":"",
        "coupons_report_columns":"",
        "customers_report_columns":"",
        "orders_report_columns":"",
        "products_report_columns":"",
        "revenue_report_columns":"",
        "taxes_report_columns":"",
        "variations_report_columns":"",
        "dashboard_sections":"",
        "dashboard_chart_type":"",
        "dashboard_chart_interval":"",
        "dashboard_leaderboard_rows":""
    },
    "_links":{
        "self":[
            {
                "href":"https://www.hejianchao.club/wp-json/wp/v2/users/22"
            }
        ],
        "collection":[
            {
                "href":"https://www.hejianchao.club/wp-json/wp/v2/users"
            }
        ]
    }
}

1.7、获取所有的用户信息

请求协议|请求方法:HTTP|GET
接口路径:/wp-json/wp/v2/users
请求头部

头部标签必填头部内容
AuthorizationBearer+token
请求头部信息

1.8、获取指定用户ID的用户信息

请求协议|请求方法:HTTP|GET
接口路径:/wp-json/wp/v2/users/用户id,如:1
请求头部

头部标签必填头部内容
AuthorizationBearer+token
请求头部信息
THE END
评论 抢沙发
头像
欢迎您留下宝贵的见解!
提交
头像

昵称

取消
昵称表情代码图片