Sleamhnú go príomh-ábhar

C# SDK

Molaimid códúchán díreach i gcoinne an API, déineann an tagairt theicniúil agus d’eintiteas AI é simplí. Is féidir SDK C# a ghiniúint ag baint úsáide as sonraíocht OpenAPI3 dár API agus gineadóir openapi. Mar sin féin, má theastaíonn uait SDK, molfaimid an tionscadal ginte atá ar fáil a úsáid, ós rud é go n-áiríonn sé ceartúcháin do roinnt fadhbanna cosúil le réimsí inléiteacha.

Click here for the C# repo..

Tá a dhoiciméadú féin sa phacáiste (i docs/), ach taispeánfaidh na samplaí thíos conas tosú.

Faigh do Eochair API​

  • Cláraigh don chuntas trialach.

  • Cumasaigh don API nuair a iarrtar ort, agus seol ríomhphost chuig Tacaíocht chun Eochair API a fháil. Ní mór duit leibhéal tuisceana a léiriú maidir le REST API a úsáid, cuir sa ríomhphost: ainm agus seoladh do chomhlachta, do ainm agus ról, déan cur síos ar do chás úsáide, agus tabhair achoimre ghearr ar do thaithí chlárúcháin / REST.

  • Nuair a dhéantar é a eisiúint, beidh do eochair API ar fáil sa aip gréasáin. Feicfidh tú go bhfuil tú i mód sandbox le 100 glao in aghaidh na huaire.

Téann do eochair API sa cheann "Authorization", agus tógann sé an fhoirm: Bearer <your-api-key>. Beidh do eochair API le feiceáil go soiléir i bPortál Forbróra.

Faigh an SDK agus Tionscadail Shamplacha​

Le d’uirlisí git is fearr leat, déan an stór C# SDK a chóipeáil.

git clone https://github.com/legalesign/LegalesignCsharpSDK.git legalesignSDK

Cumraigh an tionscadal samplach:​

Oscail LegalesignCsharpSDK.sln agus tóg an tionscadal. Ba chóir duit trí thionscadal a fheiceáil sa réiteach, dírímid ar LegalesignTest a thosóidh tú ag déanamh glaonna don REST API.

Chun am a shábháil, b’fhéidir gur mhaith leat d’ainm úsáideora, rúnda, ainm an ghrúpa, ríomhphost spriocdhírithe, ainm agus sloinne a chur mar mhaoin Text do txtUsername, txtSecretKey srl i Form1. Mura bhfuil, beidh ort iad seo a sholáthar nuair a rithfidh tú an tionscadal Winform (déan cinnte go bhfuil sé roghnaithe mar thionscadal tús). Má dhéanann tú iad a chódú go díreach bí cinnte an t-eolas sin a bhaint amach nuair a chríochnaíonn tú leis an tionscadal.

Féachaimis ar an chéad bhloic chód i Form1.cs:

private Configuration makeConfig() {
    Configuration c = new Configuration();
    c.AddApiKey("Authorization", $"Bearer {txtSecretKey.Text}");
            
    return c;
}

Is féidir leat a fheiceáil conas atá an t-ainm úsáideora agus an rúnda a sholáthraíonn tú á úsáid agus á gcur isteach sa chumraíocht do gach glao a dhéanfaidh muid níos déanaí. Seo é an bealach a ndearnadh ceadú ar ghlaonna API.

Déan tástáil ar iarratas GET:​

Déanaimis cinnte gur féidir leat iarratas simplí GET a dhéanamh, chun a sheiceáil go bhfuil do Auth cumraithe i gceart.

Rithfidh an cód seo nuair a chliceálann tú an cnaipe Get Groups. Tóg tamall chun a thabhairt faoi deara cá bhfuil an t-eolas Cumraíochta á chur isteach ag baint úsáide as makeConfig(). Rith an tionscadal, cuir do ainm úsáideora agus eochair sna boscaí mura bhfuil tú tar éis iad a chódú i bpróipriéad Text agus cliceáil an cnaipe Get Groups.

private void btnCall_Click(object sender, EventArgs e)
{           
    GroupApi group = new GroupApi(makeConfig());
    GroupListResponse groupList = group.GetGroups();
            
    richTextBox1.Text = groupList.ToJson();
}

Má rathúil gheobhaidh tú liosta JSON de do ghrúpaí.

Mura bhfuil, déan an luach Authorization a sheiceáil arís.

Faigheann an cód seo aon doiciméid atá ag fanacht le sínithe, cás úsáide coitianta. Déan tástáil orthu trí scrúdú a dhéanamh ansin ag rith an chnaipe Get Documents.

private void button2_Click(object sender, EventArgs e)
{
    DocumentApi docs = new DocumentApi(makeConfig());
    DocumentListResponse documentList = docs.GetDocuments();

    richTextBox1.Text = documentList.ToJson();
}
leide

Is bealaí níos tapúla iad na glaonna 'get_statuses()' agus 'get_status()' chun faisnéis bhunúsach doiciméid a fháil.

Ba cheart go mbeadh tú ag tuiscint conas a oibríonn an SDK. Téigh ar ais go dtí comhad Readme an phacáiste, agus feicfidh tú gach réada API le triail a bhaint astu, agus a gcuid modhanna uile.

Déan tástáil ar iarratas POST​

Ansin seolfaimid HTML saincheaptha le fáil sínithe i nglao amháin API, ansin uaslódálfaimid PDF agus seolfaimid é sin.

Seol doiciméad HTML le sínithe a fháil:​

Seo méid beag HTML le críocha taispeántais, ina bhfuil eilimint amháin síniú. Athraigh na luachanna grúpa, ainm agus ríomhphoist.

private void btnPost_Click(object sender, EventArgs e)
{
    DocumentApi docs = new DocumentApi(makeConfig());

    List<DocumentSignerPost> signers = new List<DocumentSignerPost>();
    signers.Add(new DocumentSignerPost(email: txtEmail.Text, firstname: txtFirstname.Text, lastname: txtLastname.Text));

    //You must provide group id as lowercase
    DocumentPost dp = new DocumentPost(
        group: $"/api/v1/group/{txtGroupName.Text.ToLower()}/",
        name: "dotnetdocument",
        text: rtbBodyHTML.Text,
        signers: signers,
        doEmail: true,
        footerHeight:30,
        footer: "Legalesign ID: {{doc_id}}");

    try
    {
        InlineResponse201 resp = docs.PostDocument(dp);
        richTextBox1.Text = resp.ToJson();
    }
    catch (Exception ex) {
        throw ex;
    }
}

Conas a fhios againn go ndearna sé é? Cuireann OpenAPI eisiamh ar ghlacadóirí nach bhfuil sa raon freagra 2XX. Ba mhaith leat do chuid iarratas go léir a chur i mbloic try/catch.

Gach uair a dhéanann tú POST, is dócha go mbeidh uait ID an réada nua. Tá sé i gcluaisín an Location den fhreagra. Sa sampla seo a leanas, feicimid conas PDF a uaslódáil chun é a sheoladh chuig síníochtaí, agus an ID ar ais a fháil don teimpléad nua sin.

Uaslódáil agus seol PDF​

Is dócha go n-úsáideann tú lipéid téacs laistigh de do PDFanna, chun suíomhanna daoine áirithe a shainiú do shíniú nó foirmeacha a líonadh. Déanann an paraiméadar processTags=true an córas a chur ar an eolas chun doiciméad a scanadh agus réimsí do shonraí agus síniú a chruthú don fhaighteoir. Tá sampla bunúsach PDF le lipéid san áit bhunúsach den tionscadal SDK.

Uaslódálfaimid PDF ag baint úsáide as leagan 'with_http_info' den iarratas POST chun an ID a fháil

private void btnUploadPdf_Click(object sender, EventArgs e)
{
    DialogResult result = openFileDialog1.ShowDialog();

    if (result == System.Windows.Forms.DialogResult.OK)
    {
        TemplatepdfApi pdf = new TemplatepdfApi(makeConfig());

        // Get the file and convert the contents to a base64 byte array.
        Byte[] bytes = File.ReadAllBytes(openFileDialog1.FileName);
        String contents = Convert.ToBase64String(bytes);
        Byte[] encodedBytes = Convert.FromBase64String(contents);

        try
        {
            // Upload the pdf for our group to use with a title and a tag
            ApiResponse &lt;object&gt; response = pdf.PostPdfTemplateWithHttpInfo(new TemplatePdfFieldPost(group: $"/api/v1/group/{txtGroupName.Text.ToLower()}/",
                pdfFile: encodedBytes, processTags: true, title: "test tagged document"));

            // Just to demonstrate how to read response headers we'll put the returned
            // header in the output rich text box. The 'Location' header contains the new
            // Template ID.
            richTextBox1.Text = JsonConvert.SerializeObject(response.Headers);
                    
            // We'll save this so we can use it when calling Send with Template
            txtPDFLocation.Text = response.Headers["Location"];
        }
        catch (Exception ex)
        {
            throw ex;
        }
    }
}

Mar gheall ar shocrú process_tags mar true, tá na lipéid go léir próiseáilte agus tá do PDF réidh. Mar a bhí riamh, tá an ID don PDF uainn chun é a sheoladh. Ar ámharaí an tsaoil choinnímid é i mbosca téacs txtPdfLocation.

Taispeánann an snippet cód deireanach ó Send with Template conas a úsáidimid an suíomh PDF sin chun doiciméad réamh-luchtaithe a sheoladh le síniú.

private void btnSendTemplate_Click(object sender, EventArgs e)
{
    DocumentApi docs = new DocumentApi(makeConfig());

    List<DocumentSignerPost> signers = new List<DocumentSignerPost>();
    signers.Add(new DocumentSignerPost(email: txtEmail.Text, firstname: txtFirstname.Text, lastname: txtLastname.Text));

    //You must provide group id as lowercase
    DocumentPost dp = new DocumentPost(
        group: $"/api/v1/group/{txtGroupName.Text.ToLower()}/",
        name: "dotnetdocument",
        template: txtPDFLocation.Text,
        signers: signers,
        doEmail: true,
        footerHeight: 30,
        footer: "Legalesign ID: {{doc_id}}");

    try
    {
        InlineResponse201 resp = docs.PostDocument(dp);
        richTextBox1.Text = resp.ToJson();
    }
    catch (Exception ex)
    {
        throw ex;
    }
}

Tosaigh ag códú​

Déan cinnte an doiciméadú ginte OpenAPI a sheiceáil le haghaidh cineálacha glaonna éagsúla agus roghanna.

Seo roinnt leideanna coitianta:

Ní mór go n-aontaíonn ainm an ghrúpa go díreach le ceann atá agat cheana féin i do eagraíocht.

Déanfar do iarraidh a dhiúltú más mícheart, as dáta nó faoi ghlas atá do chreidiúnaithe.

Ádh mór ar do chódú!

Athbhreithnithe go deireanach ar

Export This Article

Save a copy of this page as PDF or plain text.