Sådan opsættes et API til Member Import

Et UUID er en unik nøgle, der benyttes til at identificere et member. Der kan tilknyttes flere UUID til ét Member.

Feltet er en string uden krav til opbygning, men et typisk UUID ser ud som følger: 

"uuids": ["f56ac10b-55cc-4372-a567-0e02a3c3d859","f86ac12c-45cc-4372-a567-0e09b3c7d359"],

roles er et krævet datafelt ved eksport af et member.

Feltet bruges til at styre adgangsrettigheder i GoPublic. For "members" som kun skal vises i telefonbogen, skal der stadig tilknyttes en rolle. Her kan fx følgende rolle benyttes:

• NoRights

Rollerne i filen skal altid matche rollerne i backoffice.

Hvis nedenstående sendes i filen:

"roles": ["NoRights","LoginOnly","Admin"],

skal backoffice se ud som følger:

Member kategorier kan benyttes til at give oplysninger om den enkelte member. Fx hvilke kurser et member har fuldført, eller om et member skal vises i en telefonbog.

Kategorierne i filen skal altid matche kategorierne i backoffice.

Hvis nedenstående sendes i filen:

"categories": ["Kurser/It-sikkerhed", "Telefonbog/Vis i telefonbog"],

skal backoffice se ud som følger:

Organisations kategorierne benyttes til at placere medlemmet under en bestemt afdeling. 

Kategorierne i filen skal altid matche kategorierne i backoffice.

Hvis nedenstående sendes i filen:

a) "organizations": ["Departement/Styrelse/Afdeling1/Kontor1"],

eller

b) "organizations": ["Departement/Styrelse/Afdeling3"],

skal backoffice se ud som følger:

a)

Feltet headOfDepartment er af typen "boolean" og kan udfyldes med enten "true" eller "false". Feltet markeres "true" hvis et member er chef og sikrer at dette member står øverst, hvis en slutbruger filtrere på en afdeling i telefonbogen.

language bruges til at angive et members sprog. Feltet er en "string" og der er derfor blot tale om, at man kan angive sproget (eller nationaliteten) på et member. 

Feltet lock er af typen "boolean" og kan udfyldes med enten "true" eller "false".

Sættes værdien til "true", vil medlemmet blive låst og automatisk blive slettet efter 30 dage.

Felterne name og fullName er begge påkrævet.

Forskellen på de to felter er, at name er det navn, der vil komme til at stå ude i træstrukturen i backoffice, hvor fullName er det navn, der vil stå på medlemmet i telefonbogen.

using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        string API_ENDPOINT = "https://gapi.admin.domænenavn.dk/backend/member/import-by-api-key";
        string API_KEY = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
        string ORIGIN = "https://domænenavn.dk";
        string CSV_FILE = "Kontakter.csv";

        var members = new List<Member>();

        var lines = File.ReadAllLines(CSV_FILE, Encoding.UTF8);
        var headers = lines[0].Split(';');

        foreach (var line in lines.Skip(1))
        {
            var values = line.Split(';');
            var row = headers
                .Select((h, i) => new { h, value = i < values.Length ? values[i] : "" })
                .ToDictionary(x => x.h, x => x.value);

            var member = new Member
            {
                uuids = SplitPipe(row.GetValueOrDefault("UUID")),
                name = row.GetValueOrDefault("Name"),
                email = row.GetValueOrDefault("EmailAddress"),
                firstName = row.GetValueOrDefault("FirstName"),
                surname = row.GetValueOrDefault("Surname"),
                fullName = row.GetValueOrDefault("FullName"),
                title = row.GetValueOrDefault("Title"),
                headOfDepartment = ParseBool(row.GetValueOrDefault("HeadOfDepartment")),
                mobileNumber = row.GetValueOrDefault("MobilePhone"),
                location = row.GetValueOrDefault("Location"),
                locked = ParseBool(row.GetValueOrDefault("locked")),
                roles = SplitPipe(row.GetValueOrDefault("Roles")),
                categories = SplitPipe(row.GetValueOrDefault("Categories")),
                organizations = SplitPipe(row.GetValueOrDefault("Organizations"))
            };

            members.Add(member);
        }

        var payload = new { members };

        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", API_KEY);
        client.DefaultRequestHeaders.Add("Origin", ORIGIN);

        var json = JsonSerializer.Serialize(payload);
        var content = new StringContent(json, Encoding.UTF8, "application/json");

        var response = await client.PostAsync(API_ENDPOINT, content);

        if (response.IsSuccessStatusCode)
        {
            Console.WriteLine("Success");
        }
        else
        {
            var error = await response.Content.ReadAsStringAsync();
            Console.WriteLine($"Error: {(int)response.StatusCode} - {error}");
        }
    }

    static List<string> SplitPipe(string input)
    {
        if (string.IsNullOrWhiteSpace(input))
            return new List<string>();

        return input.Trim('"')
                    .Split('|', StringSplitOptions.RemoveEmptyEntries)
                    .Select(x => x.Trim())
                    .Where(x => !string.IsNullOrWhiteSpace(x))
                    .ToList();
    }

    static bool ParseBool(string value)
    {
        return value?.Trim().ToLower() == "true";
    }
}

public class Member
{
    public List<string> uuids { get; set; }
    public string name { get; set; }
    public string email { get; set; }
    public string firstName { get; set; }
    public string surname { get; set; }
    public string fullName { get; set; }
    public string title { get; set; }
    public bool headOfDepartment { get; set; }
    public string mobileNumber { get; set; }
    public string location { get; set; }
    public bool locked { get; set; }
    public List<string> roles { get; set; }
    public List<string> categories { get; set; }
    public List<string> organizations { get; set; }
}

Fejl '403 Forbidden' / '403 Access Denied' kommer, når der er en restriktion på sitet, der forhindrer kaldet i at gå igennem fra den IP-adresse du sidder på.

Du skal derfor tjekke din IP-adresse og fremsende den til os, så vi kan whiteliste den.

Hvis importen fejler med beskeden om at rollen ikke er fundet, skal du logge ind i backoffice og tjekke, at rollen er oprettet under 'Member roles'.

Hvis I har f.eks. både et dansk og et engelsk site, og I benytter felter, hvor indhold skal vise på henholdsvis dansk og engelsk, så skal personerne oprettes 

Requestet der sendes til vores API, skal være i JSON-format.

Hvis du får besked om, at navnet allerede findes, skal du logge ind i backoffice og tjekke om personen allerede er oprettet. Tjek også i papirkurven, da eksporten også vil fejle, såfremt personen ligger i papirkurven.

Hvis du får besked om, at email'en allerede er i brug, skal du logge ind i backoffice og tjekke om der findes en person med den fejlede email. Tjek også i papirkurven, da eksporten også vil fejle, såfremt en person med denne email ligger i papirkurven.