The official OAuth 2.0 C# SDK for the Playlyfe REST API
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.nuget
Properties
bin/Release
example
example_jwt_client
test
.gitignore
Playlyfe.cs
README.md
packages.config
playlyfe-csharp-sdk.sln
playlyfe.csproj
playlyfe.nuspec

README.md

Playlyfe C# SDK

Playlyfe C# SDKNuGet version

This is the official OAuth 2.0 C# client SDK for the Playlyfe API. It supports the client_credentials and authorization code OAuth 2.0 flows. For a complete API Reference checkout Playlyfe Developers for more information.

Note: Breaking Changes this is the new version of the sdk which uses the Playlyfe api v2 by default if you still want to use the v1 api you can do that so by passing a version key in the options when creating a client with 'v1' as the value

Examples

The Playlyfe class allows you to make rest api calls like GET, POST, .. etc. To get started initialize your client using client credentials flow and then start making requests For v2 api

var playlyfe = new Playlyfe(
    client_id: "Your client id",
    client_secret: "Your client secret",
    type: "code",
    store: null,
    load: null,
    version: "v2",
    tokenEndPoint: "https://playlyfe.com/auth/token",
    apiEndPoint: "https://api.playlyfe.com"
);
// This will take your client id and secret and use it to fetch the
// access token to make further requests.

// To get infomation of a  player
dynamic player = playlyfe.get(
  route: "/runtime/player",
  query: new Dictionary<string, string> () { {"player_id", "student1" }}
);
Console.WriteLine(player["id"]);
Console.WriteLine(player["alias"]);

// To get all available processes
// Note if the response is an array then you need to pass list as true
// and the result will be a List of dynamics
List<dynamic> processes = playlyfe.get(
  route: "/runtime/processes",
  query: new Dictionary<string, string> () {{"player_id", "student1"}},
  list: true
)
Console.WriteLine(processes["total"]);
// To start a process
dynamic process =  playlyfe.post(
  route: "/runtime/processes",
  query: new Dictionary<string, string> () { {"player_id", "student1"} },
  body: new { name = "My First Process", definition = "module1" }
);

//To play a process
playlyfe.post(
  route: "/runtime/processes/"+process_id+"/play",
  query: new Dictionary<string, string> () { {"player_id", "johny"} },
  body: new { trigger = trigger_name }
);

// A PLaylyfeException is thrown when an error from the playlyfe platform is returned on a request
try {
  playlyfe.get(
    route: "/unkown",
    query: new Dictionary<string, string>(){ {"player_id", "student1"}}
  );
}
catch(PlaylyfeException err) {
  Console.WriteLine (err.Name); // route_not_found
  Console.WriteLine (err.Message); // This route does not exist
}

Requires

.NET >= 4.0 or Mono >= 3.2.8

Install

You can direcly download the playlyfe.dll file and reference it in your project or if you are using nuget

nuget install playlyfe

Using

Create a client

If you haven't created a client for your game yet just head over to Playlyfe and login into your account, and go to the game settings and click on client.

1. Client Credentials Flow Nancy Framework

In the client page select Yes for both the first and second questions client

A typical nancy app using client credentials code flow with a single route would look something like this

    public class Client : NancyModule
    {
        public static Playlyfe plClient = null;
        public Client ()
        {
            if (plClient == null)
                plClient = new Playlyfe (
                    client_id: "Zjc0MWU0N2MtODkzNS00ZWNmLWEwNmYtY2M1MGMxNGQ1YmQ4",
                    client_secret: "YzllYTE5NDQtNDMwMC00YTdkLWFiM2MtNTg0Y2ZkOThjYTZkMGIyNWVlNDAtNGJiMC0xMWU0LWI2NGEtYjlmMmFkYTdjOTI3",
                    type: "client",
                    store: null,
                    load: null,
                    version: "v1"
                );
            Get["/client"] = parameters => {
                dynamic players = plClient.get(route: "/game/players", query: null);
                return listAllPlayers(players);
            };
        }

        public static String listAllPlayers(dynamic players)
        {
            var html = "<ul>";
            foreach(dynamic player in players["data"]) {
                html += "<li><p>";
                html += "<bold>Player ID</bold>:   "+ player["id"];
                html += "<bold>Player Alias</bold>:    "+ player["alias"];
                html += "</p></li>";
            }
            html += "</ul>";
            return html;
        }
    }

2. Authorization Code Flow

In the client page select yes for the first question and no for the second auth

In this flow you will have a route which will get the authorization code and using this the sdk can get the access token. You need a view which will allow your user to login using the playlyfe platform. And then playlyfe server will make a get request with the code to your redirect uri. And you should find the code in the query params of the url and exchange the code with the Playlyfe SDK.

exchange_code(code)

Host your ASP.NET server with ip address localhost:3000

Now you should be able to access the Playlyfe api across all your routes.

    public class Code : NancyModule
    {
        public static Playlyfe plCode = null;
        public static string user = null;
        public Client ()
        {
            Get ["/code"] = parameters => {
               if(plCode == null)
                  plCode = new Playlyfe(
                    client_id: "OGUxYTRlZWUtZTAyOS00ZThjLWIyNzQtNGEwMGRiNjk1ZGRj",
                    client_secret: "NDMyMDMyOTktM2NhOS00MGJlLTg4NzYtZWJjMzNhNTE1NDYwYTc1NGU2NTAtNWI1ZS0xMWU0LTkwYTEtYTM4MzkzMzkxZTY1",
                    type: "code",
                    redirect_uri: "http://localhost:3000/code",
                    store: null,
                    load: null,
                    version: "v1"
                  );
                var dict = (DynamicDictionary) this.Request.Query;
                if(dict.ContainsKey("code")) {
                    plCode.exchange_code(dict["code"].ToString());
                    user = "logged_in";
                }
                if(user != null)
                {
                    dynamic players = plCode.get(route: "/game/players", query: null);
                    return listAllPlayers(players);
                }
                else {
                    return "<a href=\""+ plCode.get_login_url() + "\">Please Login to your Playlyfe Account</a>";
                }
            };

            Get ["/logout"] = parameters => {
                user = null;
                return "logged_out";
            };
        }
    }

3. Custom Login Flow using JWT(JSON Web Token)

In the client page select no for the first question and yes for the second jwt

using Playlyfe;
String[] scopes = { "player.runtime.read", "player.runtime.write" };
String token = Playlyfe.Playlyfe.createJWT ("your client_id", "your client_secret",
    "student1",// The player id associated with your user
    scopes, // The scopes the player has access to
    3600 // 1 hour expiry Time
);

This is used to create jwt token which can be created when your user is authenticated. This token can then be sent to the frontend and or stored in your session. With this token the user can directly send requests to the Playlyfe API as the player. The token is usually generated in your backend server.

If you would like to use a C# Client with the jwt flow then you can specify the type in the client creation part like this and you will need to request a new token from your backend route which serves the token using getJWTToken().

var jwtClient = new Playlyfe.Playlyfe (
	client_id: "your_client_id",
	client_secret: "your_client_secret",
	type: "jwt",
	store: null,
	load: null,
	version: "v2"
);
// Note you will need to run the ASP Server in the example_server project which serves the token
jwtClient.getJWTToken ("http://localhost:3000/JWT_TOKEN");
var player_id = new Dictionary<string, string> (){ { "player_id", "student1" } };
dynamic player = jwtClient.get(route: "/runtime/player", query: player_id);
Console.WriteLine (player);

You can take a look at the examples in the source to see how it works.

Client Scopes

Client

Your client has certain access control restrictions. There are 3 kind of resources in the Playlyfe REST API they are,

1./admin -> routes for you to perform admin actions like making a player join a team

2./design -> routes for you to make design changes programmatically

3./runtime -> routes which the users will generally use like getting a player profile, playing an action

The resources accessible to this client can be configured to have a read permission that means only GET requests will work.

The resources accessible to this client can be configured to have a write permission that means only POST, PATCH, PUT, DELETE requests will work.

The version restriction is only for the design resource and can be used to restrict the client from accessing any version of the game design other than the one specified. By default it allows all.

If access to a route is not allowed and then you make a request to that route then you will get an error like this,

{
  "error": "access_denied",
  "error_description": "You are not allowed to access this api route"
}

Documentation

You can initiate a client by giving the client_id and client_secret params

Playlyfe(
    client_id: "Your client id",
    client_secret: "Your client secret",
    type: "client" or "code" or "jwt",
    redirect_uri: "The url to redirect to" //only for authorization code flow
    store: token => { Console.WriteLine("storing"); }  // The lambda which will persist the access token to a database. You have to persist the token to a database if you want the access token to remain the same in every request
    load:  delegate {
        var dict = new Dictionary<string, string>() {
            "access_token", "my access token",
            "expires_at", "expires_at_time"
        };
        return dict;
    } // The lambda which will load the access token. This is called internally by the sdk on every request so that the access token can be persisted #between requests
)

In development the sdk caches the access token in memory so you don"t need to provide the store and load lambdas/delegates. But in production it is highly recommended to persist the token to a database. It is very simple and easy to do it with redis. You can see the test cases for more examples.

    new Playlyfe(
      client_id: "Your client id",
      client_secret: "Your client secret",
      type: "client",
      store: null,
      load: null
    )

API

dynamic or List<dynamic>
api(
    method: "GET" // The request method can be GET/POST/PUT/PATCH/DELETE
    route: "" // The api route to get data from
    query: Dictionary<string, string> // The query params that you want to send to the route
    raw: false // Whether you want the response to be in raw string form or json
    list: false // When the response is an array then you need to pass this as true for proper deserialization and the result will be List<dynamic>
)

Get

dynamic or List<dynamic>
get(
    route: "" // The api route to get data from
    query: Dictionary<string, string> // The query params that you want to send to the route
    raw: false // Whether you want the response to be in raw string form or json
    list: false // When the response is an array then you need to pass this as true
    //for proper deserialization and the result will be List<dynamic>
)

Post

dynamic post(
    route: "" // The api route to post data to
    query: Dictionary<string, string> // The query params that you want to send to the route
    body: new {} // The data you want to post to the api this will be automagically converted to json
    list: false // When the response is an array then you need to pass this as true
    //for proper deserialization and the result will be List<dynamic>
)

Patch

dynamic patch(
    route: "" // The api route to patch data
    query: Dictionary<string, string> // The query params that you want to send to the route
    body: new {} // The data you want to update in the api this will be automagically converted to json
    list: false // When the response is an array then you need to pass this as true
    //for proper deserialization and the result will be List<dynamic>
)

Put

dynamic put(
    route: "" // The api route to put data
    query: Dictionary<string, string> // The query params that you want to send to the route
    body: new {} // The data you want to update in the api this will be automagically converted to json
    list: false // When the response is an array then you need to pass this as true
    //for proper deserialization and the result will be List<dynamic>
)

Delete

dynamic delete(
    route: "" // The api route to delete the component
    query: Dictionary<string, string> // The query params that you want to send to the route
    list: false // When the response is an array then you need to pass this as true
    //for proper deserialization and the result will be List<dynamic>
)

Get Login Url

string get_login_url()
//This will return the url to which the user needs to be redirected for the user to login. You can use this directly in your views.

Exchange Code

void exchange_code(String code)
//This is used in the auth code flow so that the sdk can get the access token.
//Before any request to the playlyfe api is made this has to be called atleast once.
//This should be called in the the route/controller which you specified in your redirect_uri

Get The JWT Token From your backend route

void getJWTToken(String url)
// where url is the url to your backend route which serves the JWT token

Errors

A PlaylyfeException is thrown whenever an error occurs in each call.The Error contains a Name and Message field which can be used to determine the type of error that occurred.

Author

Peter John

Contributors

Kumar Harsh Rafael Kato

License

Playlyfe C# SDK

http://dev.playlyfe.com/

Copyright(c) 2014-2015, Playlyfe IT Solutions Pvt. Ltd, support@playlyfe.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributing

  1. Install Monodevelop >= 5.2
  2. Install nuget
  3. Run mono /usr/bin/nuget.exe install in the folder or install it from the gui
  4. To Run Test change to Debug Mode and View to Visual Designer Click and then on Pads Unit Tests
  5. Change version in Assembly.cs
  6. Make a release target
  7. Run nuget pack playlyfe.nuspec
  8. Upload the nuget package online