https://github.com/edragonconnect/ex_aliyun_openapi

Aliyun openapi tools written in elixir
https://github.com/edragonconnect/ex_aliyun_openapi

aliyun-api

Last synced: about 2 months ago
JSON representation

Aliyun openapi tools written in elixir

• Host: GitHub
• URL: https://github.com/edragonconnect/ex_aliyun_openapi
• Owner: edragonconnect
• Created: 2019-03-27T02:55:50.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-12T06:51:38.000Z (about 2 years ago)
• Last Synced: 2024-10-21T00:36:18.314Z (2 months ago)
• Topics: aliyun-api
• Language: Elixir
• Homepage: https://hexdocs.pm/ex_aliyun_openapi
• Size: 43.9 KB
• Stars: 4
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ExAliyun.OpenAPI

[![Module Version](https://img.shields.io/hexpm/v/ex_aliyun_openapi.svg)](https://hex.pm/packages/ex_aliyun_openapi)

[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/ex_aliyun_openapi/)

[![Total Download](https://img.shields.io/hexpm/dt/ex_aliyun_openapi.svg)](https://hex.pm/packages/ex_aliyun_openapi)

[![Last Updated](https://img.shields.io/github/last-commit/edragonconnect/ex_aliyun_openapi.svg)](https://github.com/edragonconnect/ex_aliyun_openapi/commits/master)

## Description

ExAliyun.OpenAPI supports aliyun openapis:

* CPS(移动推送服务)

* STS(短期访问权限管理)

* SMS(短信服务)

* AFS(人机验证)

* CodeUp(云效任务管理)

* GeoIP(查询 IP 地理位置)

* more to be supported

## Installation

If [available in Hex](https://hex.pm/packages/ex_aliyun_openapi), the package can be installed

by adding `ex_aliyun_openapi` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:ex_aliyun_openapi, "~> 0.8"}

  ]

end

```

## Configuration

You should add configs for your services in this way.

```elixir

config :ex_aliyun_openapi, type,

  access_key_id: "YOUR CPS ACCESS KEY ID",

  access_key_secret: "YOUR CPS ACCESS KEY SECRET"

```

type support `[:cps, :sts, :sms, :global_sms, :afs, :codeup, :geoip]`

## Call the apis

You can find the api params in [https://help.aliyun.com](https://help.aliyun.com).

Then you can choose the service, and just put the params to it.

```elixir

params = %{

  "Action" => "AssumeRole",

  "RoleArn" => "**YOUR RoleArn**",

  "RoleSessionName" => "default",

  "DurationSeconds" => 3600,

}

ExAliyun.OpenAPI.call_sts(params)

# or

ExAliyun.OpenAPI.call_sts(params, access_key_id: "ID", access_key_secret: "SECRET")

```

```elixir

params = %{

  "Action" => "PushNoticeToAndroid",

  "AppKey" => "**YOUR AppKey**",

  "Target" => "DEVICE",

  "TargetValue" => "**YOUR device_id**",

  "Title" => "TEST title",

  "Body" => "Hello, this is the notice body"

}

ExAliyun.OpenAPI.call_cps(params)

# or

ExAliyun.OpenAPI.call_cps(params, access_key_id: "ID", access_key_secret: "SECRET")

```

## To add more services to this repo

1. You should add the specific function into `ex_aliyun_openapi.ex`.

2. Complete the corresponding unit tests.