https://engine.speedle.io/tags/api/ Recent content in Api on Speedle Hugo -- gohugo.io en-us Fri, 18 Jan 2019 21:19:44 +0800 https://engine.speedle.io/docs/api/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/docs/api/ Client libraries for Java, Python, Go, .NET, Rust and Node.js/TypeScript are in SDKs. REST APIs These are reference contracts for your configured PMS/ADS or asserter endpoint. speedle.io serves documentation and the browser Playground; it is not a hosted PMS/ADS service. Supply JSON with Content-Type: application/json, and configure TLS/mTLS and caller access controls. Policy management API Authorization decision API Token assertion webhook Policy and role-policy IDs are strings. PMS responses are flat objects; authorization permissions use permissions (plural). https://engine.speedle.io/docs/api/decision_api/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/docs/api/decision_api/ Reference for your configured ADS. Request attributes are typed arrays; diagnostic attributes are objects. Security and endpoint configuration. This is a contract reference, not a backend hosted by speedle.io. (function() { var url = "\/swagger\/policy-check.yaml"; const ui = SwaggerUIBundle({ url: url, dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], validatorUrl: null, layout: " https://engine.speedle.io/docs/sdks/dotnet/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/docs/sdks/dotnet/ The .NET SDK targets .NET 8 or later and has no dependencies. Package: Speedle.Sdk 0.1.0 on NuGet, namespace Speedle.Sdk. Reference: speedle-sdk/dotnet. The examples check the policy described in the SDKs overview. Add the dependency In a new console project: dotnet new console -o SpeedleExample cd SpeedleExample dotnet add package Speedle.Sdk --version 0.1.0 Call a local Speedle Start Speedle and create the example policy as described in the SDKs overview. Replace Program. https://engine.speedle.io/docs/sdks/go/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/docs/sdks/go/ The Go SDK supports the two latest Go releases and uses only the standard library. Module: github.com/teramoby/speedle-sdk/go v0.1.0, package speedle. Reference: speedle-sdk/go. The examples check the policy described in the SDKs overview. Add the dependency In a new module: go mod init example.com/speedle-example go get github.com/teramoby/speedle-sdk/go@v0.1.0 Call a local Speedle Start Speedle and create the example policy as described in the SDKs overview. Save this program as main.go: package main import ( "context" "fmt" "os" speedle "github. https://engine.speedle.io/docs/sdks/java/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/docs/sdks/java/ The Java SDK needs Java 17 or later and has no runtime dependencies. Package: io.speedle:speedle-sdk 0.1.0 on Maven Central. Reference: speedle-sdk/java. The examples check the policy described in the SDKs overview. Add the dependency Maven, a complete pom.xml: <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.example</groupId> <artifactId>speedle-example</artifactId> <version>1.0</version> <properties> <maven.compiler.release>17</maven.compiler.release> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> </properties> <dependencies> <dependency> <groupId>io.speedle</groupId> <artifactId>speedle-sdk</artifactId> <version>0.1.0</version> </dependency> </dependencies> </project> Gradle, a complete build.gradle.kts (with a settings.gradle.kts that sets rootProject. https://engine.speedle.io/docs/sdks/node/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/docs/sdks/node/ The Node.js SDK needs Node.js 22 or later, ships ESM and CommonJS builds with TypeScript types, and has no runtime dependencies. Package: @speedle/sdk 0.1.0 on npm, available when published. Reference: speedle-sdk/node. The examples check the policy described in the SDKs overview. Add the dependency In a new ES module package (available when published): mkdir speedle-example cd speedle-example npm init -y npm pkg set type=module npm install @speedle/sdk@0.1.0 Call a local Speedle Start Speedle and create the example policy as described in the SDKs overview. https://engine.speedle.io/docs/api/management_api/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/docs/api/management_api/ Reference for your configured PMS. Requests and responses are JSON; policy IDs are strings and responses are flat objects. Security and endpoint configuration. This is a contract reference, not a backend hosted by speedle.io. (function() { var url = "\/swagger\/policy-manage.yaml"; const ui = SwaggerUIBundle({ url: url, dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis ], plugins: [ SwaggerUIBundle. https://engine.speedle.io/docs/sdks/python/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/docs/sdks/python/ The Python SDK needs Python 3.10 or later; its only runtime dependency is httpx. It has a sync Client and an asyncio AsyncClient with the same arguments. Package: speedle 0.1.0 on PyPI. Reference: speedle-sdk/python. The examples check the policy described in the SDKs overview. Add the dependency With pip, in a virtual environment: python3 -m venv .venv . .venv/bin/activate pip install speedle==0.1.0 Or with uv, in a uv project: https://engine.speedle.io/docs/sdks/rust/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/docs/sdks/rust/ The Rust SDK needs Rust 1.75 or later. It is async on tokio and reqwest (rustls); the blocking feature adds the blocking client used below. Crate: speedle 0.1.0 on crates.io. Reference: speedle-sdk/rust. The examples check the policy described in the SDKs overview. Add the dependency In a new package: cargo new speedle-example cd speedle-example cargo add speedle@0.1.0 --features blocking Call a local Speedle Start Speedle and create the example policy as described in the SDKs overview. https://engine.speedle.io/docs/pms/ Fri, 18 Jan 2019 21:19:44 +0800 https://engine.speedle.io/docs/pms/ Policy Management Global Policy Policy Discovery Policy Diagnosis https://engine.speedle.io/docs/api/asserter_api/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/docs/api/asserter_api/ Webhook reference. errCode is an integer and attributes is an object. Configure the actual endpoint in the ADS asserter configuration. Security and endpoint configuration. This is a contract reference, not a backend hosted by speedle.io. (function() { var url = "\/swagger\/asserter.yaml"; const ui = SwaggerUIBundle({ url: url, dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis ], plugins: [ SwaggerUIBundle.