API--应用层之间的应用程序接口

news2025/1/18 1:56:33

API的前言

互联网的应用特点是具有开放式的业务体系结构之一。关键的技术就是网络控制与应用层之间的应用程序接口--API。通过API接口很多问题便水到渠成,迎刃而解 。

API到底是一种什么技术呢

具有开放式的业务体系结构将是下一代网络的重要特征之一。其中,关键的技术之一就是网络控制与应用层之间的应用程序接口(API)。通过联接应用程序API,业务开发商 、独立软件提供商 (ISV)等第三方应用可以获得使用现有网络资源的能力,不用再去编写领域外的程序,即可拿来提供商开发好的专业程序,通过各行各业的API接口完美的解决了行业之间的壁垒难题。

API--应用程序接口的简称

API 是一些功能、定义或者协议的集合,提供应用程序或者程序开发人员基于软件访问一组例程的能力,对外封装完善,调用时无需编写与学习 API内部源码,依据 API文档功能说明书来使用即可。

API接口的数据有多种格式

当前 API 接口支持 XLSX、CSV、RDF、JSON、XML等数据格式,其中 JSON 和 XML 是主流的数据格式,几乎所有 API 接口都支持这两种数据格式。

JSON (JavaScript Object Notation)是一种轻量级的数据交换格式,具有良好的可读和便于快速编写的特性,可在不同平台之间进行数据交换。

XML 是扩展标记语言(Extensible Markup Language),用于标记电子文件使其具有结构性的标记语言,可以用来标记数据、定义数据类型,是一种允许用户对自己的标记语言进行定义的源语言。

JSON与XML相比的不同特点。

JSON与XML 相比是一种更加轻量级的数据格式,而且更加易于解析,支持多种语言,这使得 JSON 在大数据时代备受欢迎,而且随着应用程序和平台的不断发展,应用程序的功能变得越来越复杂,但为了保证用户体验的优化,需要通过重构代码,将复杂的逻辑封装在内部,保持其对外提供的 API 仍然简洁。JSON 也正因为简洁这一优势逐渐超越了XML,成为了应用间的首选数据交换格式。

API接口功能:

用户系统接口可查询个人信息、账户收支明细、即将过期接口、当前接口请求数,无需登录用户就可便捷查询。

Api文档:

子接口:

  • 接口用量查询

  • 个人信息

  • 即将到期接口

  • 账户明细

  • 当天请求数

接口地址: https://登录后显示/api/67/245(支持:http/https)

返回格式:json,xml

请求方式:GET,POST

POST 请求需要设置Header头:Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求说明:

名称

必填

类型

说明

示例 参数另存

appid

String

应用ID,在后台我的应用查看或者添加

1

format

String

返回数据格式类型,每个接口已经说明支持返回格式:json,xml

json

sign

String

1.使用Md5方式验证,参数按一定规则md5后返回的字符串,详情点击这里阅读

2.使用Hash验证方式,直接跟上密钥即可。

通过我的应用里面修改验证方式

52a32be274a5c

Md5验证方式-加密顺序:

sign = MD5( appid1formatjson密钥) 查看加密规则说明 密钥不需要键名,请直接跟上32位的密钥

红色部分代表参数值,appid默认为1,请修改为自己的appid值,去我的应用查看以及密钥

*注意:空值不参与加密。

返回参数说明:

名称

必填

类型

说明

示例 参数另存

api_auth

Integer

授权方式:1 按次,2按月,0免费

api_id

Integer

接口的唯一标识

105

api_name

String

接口名称

全国城市概要简介

available

Integer

可用次数或者到期日期,按次计费的接口显示的是可用次数,按月计费的显示的是到期日期

2020-10-09

codeid

Integer

状态码,返回10000状态都会进行计费。具体说明可查看状态码说明

10000

curtime

String

当前服务器时间戳

1605170402

message

String

请求状态说明

操作成功!

retdata

Array

回数据集合,可能是数据、对象或者字符串

JSON返回示例:

codeid

:

10000

message

:

操作成功!

retdata

[4]

curtime

:

1605170402

状态码说明:

状态码

说明

10000

返回成功

10001

appid必须指定,可以我的应用里面查看

10002

sign值必须指定,加密规则请前往帮助中心查看

10003

sign值验证不通过,加密规则请前往帮助中心查看

10004

时差不能超过10分钟,可以不传递这个参数,注意时间戳单位是秒

10005

appid错误,请检查appid值,前往会员中心->我的应用查看或添加

10006

当前IP地址未授权,请前往用户中心->我的应用添加ip{@info}

10007

应用被禁用,请联系客服处理

10008

应用内没有该接口,请到我的应用里面添加这个接口

10009

api接口不存在

10010

您没有添加该api接口

10011

api已经到期

10012

没有订购任何api,请前往购买后再操作

10013

该接口已经暂停使用

10014

未知的错误,可以联系客服处理

10015

参数个数错误

10019

{@info}

10017

time必须是整型

10018

次数不足

10020

子接口不存在,可能已经被关闭

10021

服务器发生错误

10022

帐户余额不足,请充值!

10023

订单提交成功,等待回调结果

10024

调试模式数据

10025

查无数据

请求示例:

  • PHP

  • Python

$method = 'GET'; //请求方式 GET,POST
$secretType = 'MD5'; //验证方式MD5,Hash 通过后台 我的应用去修改
$api_url = 'https://登录后显示/api/67/245';
$appid  =   '应用id';// 在后台我的应用查看;
$secret =   '应用密钥';// 在后台我的应用查看;
$data = array(
    'appid'=>  '1',
    'format'=>  'json',
    );

$data['appid'] = $appid;
$data['time'] = time();//当前服务器时间

if('MD5' == $secretType){
    ksort($data); //按照键名对数组排序,为数组值保留原来的键。
    $md5String = '';
    foreach($data as $key=>$val){
        if(strlen($val)>0){ //过滤空值
            $md5String.=$key.$val;
        }
    }
    $secret = md5($md5String.$secret);
}
$data['sign'] = $secret;
if('GET'==$method){
    $sendUrl = $api_url.'?'.http_build_query($data); //把数据转换成url参数形式,a=b&c=d&e=f
    $result = file_get_contents($sendUrl);
}else{
    $header = ['Content-Type: application/x-www-form-urlencoded;charset=utf-8'];
    $ch = curl_init();
    if(is_array($data))$data = http_build_query($data);
    curl_setopt($ch, CURLOPT_URL, $api_url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
    curl_setopt($ch, CURLOPT_POST, true);//POST
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    curl_setopt($ch, CURLOPT_AUTOREFERER, true);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
    curl_setopt($ch, CURLOPT_ENCODING,'gzip,deflate');
    $result = curl_exec($ch);
}
$result = json_decode($result,true);
print_r($result);

                        

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/161933.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

干货 | APP和小程序在开发有什么区别?

随着互联网的不断进步,移动终端在生活中的应用也越来越多。 据工信部数据显示,截至2022年11月底,国内市场监测到的APP数量为272万款,其中App Store(中国区)的APP数量为136万款,本土第三方应用商店(主要是安…

数据库连接池监控的另类方案

如果这篇对你有帮助,还请麻烦转发。谢谢。数据库的连接池的监控的重要性假如,我们在公有云上存在一个数据库数据库实例X。公有云配置中已经说明X所支持的最大连接数是1000。如果数据库X的实际连接数达到了1000,那么,新的连接就无法…

输入的文本就能演奏一段爵士乐? #Riffusion

riff diffusion 是 stable diffusion 的微调模型,以生成频谱图图像来转换音乐。能产生更精准的声音模型叫:Riffusion。它能对音频进行剪辑处理,或者是无限地修改提示符。Riffusion图源:riffusion 官网频谱图频谱图是音频声波的视…

【超分综述】

A comprehensive review on deep learning based remote sensing image super-resolution methods (基于深度学习的遥感图像超分辨率方法综述) 卫星图像是地球科学领域各种应用的重要地理信息源。然而,由于光学和传感器技术的局限性以及传感器和设备更新的高成本&…

迅为i.MX8M Mini开发板debug调试方法(Qir trl RIL驱动不工作)

可能导致 Quectel RIL 操作失败的原因有很多。一些常见的原因如下所示,用于故障排除。 1 输入以下命令用于检查 ril daemon 的状态。如果未返回任何值,或者返回了 Stopped 或 Restarting 等 值而不是 Running,则表明 RIL 守护进程未运行。 ge…

时序预测 | Python实现Attention-TCN注意力机制时间卷积神经网络的多元时间序列预测

时序预测 | Python实现Attention-TCN注意力机制时间卷积神经网络的多元时间序列预测 目录 时序预测 | Python实现Attention-TCN注意力机制时间卷积神经网络的多元时间序列预测预测效果基本介绍环境配置程序设计模型效果参考资料预测效果 基本介绍 使用时间注意卷积神经网络进行…

2023版大数据学习路线图(适合自学)

随着信息产业的迅猛发展,大数据应用逐渐落地,行业人才需求量逐年扩大。大数据成为目前最具前景的高薪行业之一,大数据分析工程师、大数据开发工程师等大数据人才也成为市场紧缺型人才,薪资一涨再涨。很多人想要加入到大数据开发行…

学会这几个方法,帮你轻松完成工作

方法一:分节 分节有比分页更体贴入微的分节功能。 “节”在word中是很重要的,它代表着文档中的标记。 分页只是视觉上产生了一个新页,分节让Word在内容上建立一个个不同的区域。 操作方法: 鼠标光标定位在需要分节的文档位置…

Java-Jstack-生产问题的排查死锁/泄露/cpu负载

文章目录 排查死锁jdk自带的jstack排查死锁jdk自带的jconsole排查死锁排查CPU爆满内存溢出、泄漏排查内存溢出定位 - 内存泄漏内存溢出实战排查死锁 首先如果是本地开发环境可以通过JVisualVM查看是否有长时间休眠的线程 注意:正式部署版本不会用JVisualVM,会留下漏洞jdk自带…

第一天总结之项目的搭建

第一天总结之项目的搭建: Mvc框架的搭建 1、创建一个javaWeb项目 创建项目 添加web支持 在Web-INF下创建 classes和lib文件夹 重构项目 配置tomcat 2、搭建 Mvc框架 在src下创建 com.edu文件夹 在其下分别创建controller dao entity filter service utils文件夹…

Clion配置openCV开发环境(Clion+MinGW+CMake+openCV)

所需资源 系统 win11(X64)MinGW-W64 GCC-8.1.0 x86_64-8.1.0-release-posix-seh.7z MinGW作用是opencv需要用到支持多线程(posix版本)的C编译环境。Clion-2022.3.1.exeCMake-3.25.1-windows-x86_64.msiopenCV4.6.0 安装步骤 解压ming.7z,安…

node.js全栈项目

一、项目介绍本项目适合作为一个课程设计或者毕业设计,最终实现了一个完整的博客系统,包括用户的登录、注册,图片上传,文章的发布、富文本编辑器、删除、编辑、修改、列表展示,评论的发布、删除、列表展示,…

K2P padavan固件下宽带与IPTV融合

一、我的需求 坐标江苏小城,原来手机用的99的套餐,可以免费带一个副卡,现在升级了电信129的5G融合套餐,送了一个iTV(一个月10元),但是副卡收费10元,哎,算来算去都没有运营…

【软考】系统集成项目管理工程师(十三)项目干系人管理

一、项目干系人管理基础二、干系人管理子过程1. 识别干系人2. 规划干系人管理3. 管理干系人4. 控制干系人参与一、项目干系人管理基础 项目干系人管理是指对项目干系人需求、希望和期望的识别,并通过沟通上的管理来满足 其需要、解决其问题的过程。 每个项目都有干系人,他们…

雅思经验(3)

听力技巧:section 1错1,section 2错2,section 3错5,section 4错5,共错13题,才擦边达到6.5分。听力的关键点在于2和4,因为1和3的场景基本可以固定下来。剑9的section3那个Soiros同学真的很可怕,印度人,口音真的非常重,但…

LVGL基础部件学习笔记

目录 1、基础对象基本属性用法(所有部件都可以用) 1.1、基础对象的大小(Size) 1.2、基础对象的位置(Position) 1.3、基础对象对齐(Alignment) 1. 4、基础对象的盒子模型(border-box) 1.5、基础对象的样式(styles) 1.6、基础对象的事件(events) 2…

小偷与守望者.math库.动态规划.贪心.C

1.分别讨论0或1;边界 2.写出递推方程;最优子结构、状态转移方程、重叠子问题 int rob(int* arr, int size){ int dp[size];int result; if(size0)return 0; if(size1)return arr[0]; else{ dp[0]arr[0]; dp[1]arr[1] > arr[0] ? arr[1]:arr[0]; for (int i 2; i < siz…

php学习笔记-连接操作mysq数据库(基础)-day08

php学习笔记-连接操作mysq数据库-day08php中常用的mysql操作函数1.连接mysql服务器mysqli_connect()2.设置数据库字符集 和 发送sqlmysqli_query() 函数 可以用来设置数据库字符集。3.关闭mysql服务器连接mysqli_close();4.选择要操作的数据库mysqli_select_db()5.结果集释放my…

C#大型在线学习平台源码(PC端+手机端)

本套源码目录结构清晰、代码层次分明、文档齐全。源码分享&#xff01;需要源码学习可私信我获取。 系统简介 中小学教育平台是一个集学、练、考于一体的在线教育平台&#xff0c;可以帮助中小学教育机构建设网络课堂&#xff0c;用于同步课程、专题课堂、兴趣课堂等网络教育的…

当用户输入一堆这样的字符串到 Elasticsearch ?

1、问题引出如下样例数据已导入 Elasticsearch&#xff0c;如何实现特定字段检索&#xff1f;并计算出特定子字段的长度&#xff1f;"message": "[策略排序]排序后结果:[{\"intentItems\":[\"200001\"],\"level\":1,\"modul…